Skip to content

Commit

Permalink
docs: update contributing guide (release instructions) (#1385)
Browse files Browse the repository at this point in the history
**Issue number:**

## Summary

### Changes

> Please provide a summary of what's being changed

### User experience

> Please describe what the user experience looks like before and after
this change

## Checklist

If your change doesn't seem to apply, please leave them unchecked.

* [ ] I have performed a self-review of this change
* [ ] Changes have been tested
* [ ] Changes are documented
* [ ] PR title follows [conventional commit
semantics](https://www.conventionalcommits.org/en/v1.0.0/)
  • Loading branch information
lplonka-splunk authored Oct 17, 2024
1 parent f420f64 commit 412e577
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,8 @@ gh pr merge develop --auto --merge
- Ensure CI passes and await team review.
- PR should be merged using **merge commit** option in GitHub (already included in the command)
- Releases are made automatically (both on GitHub and PyPI), and a bot will push a commit to `main` with all necessary changes (i.e. [like this](https://github.com/splunk/addonfactory-ucc-generator/commit/0c5e6802e1e52c37bf7131baf1b8264e5db30545))
- If necessary, update release notes and CHANGELOG.md accordingly to the content of the release.
- If any issue was solved by this release, remove **waiting-for-release** label from it and then close the issue.
- After the release, backport the bot's changes to the `develop` branch (i.e. [#974](https://github.com/splunk/addonfactory-ucc-generator/pull/974)):
```bash
Expand All @@ -133,3 +135,8 @@ gh pr merge main --auto --merge
+ Ensure CI passes and await team review.
+ Merge the PR using the merge commit option on GitHub.
+ Backport the bug fix PR to the develop branch.
- After release is done, announce it to community on slack channels:
+ [Internal UCC channel](https://splunk.enterprise.slack.com/archives/C03T8QCHBTJ)
+ [Splunk Usergroup UCC channel](https://splunk-usergroups.slack.com/archives/C03SG3ZL4S1)

0 comments on commit 412e577

Please sign in to comment.