Skip to content

Commit

Permalink
Add how to release documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ehelms authored and evgeni committed Jan 9, 2023
1 parent b120a2f commit 1c4ed8f
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion docs/update_repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The basic update is to merge in upstream changes from a target release version a
git checkout -b update-to-<target tag>
git remote add upstream https://github.com/theforeman/foreman-operations-collection
git fetch upstream
git merge upstream/<target tag>
git merge <target tag>
make branding
```

Expand All @@ -20,3 +20,18 @@ When new roles are added from upstream there are two options for dealing with th
1. A new role that isn't being shipped with Satellite. This role should be added to the Makefile removal list and then re-run `make branding`.
2. A new role that is being shipped with Satellite. This role should have a test folder `roles/<new role>/molecule/satellite` added to it.
This test folder should include any testing needed to verify this role in a Satellite context.

# How to Release Repository

After making local changes for branding:

* Create a pull request with the changes

* After merging, tag the merge commit with `<version number>` (i.e. v1.2.0).
Please use signed tags.

* Generate a copy of the source tarball locally: `make dist`

* Visit the UI for the tag (e.g. [v1.2.0](https://github.com/RedHatSatellite/satellite-operations-collection/releases/tag/v1.2.0) and click the "Create release from tag" button

* Edit the release title to the name of the tag (e.g. v1.2.0) and upload the generated source tarball, then click `Publish Release`

0 comments on commit 1c4ed8f

Please sign in to comment.