Skip to content

Commit 77c4a18

Browse files
committed
docs: release instructions
1 parent e70cca6 commit 77c4a18

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,27 @@ The collection is arranged as follows:
6868

6969
A role that extends the core PCP role, exporting metrics from
7070
PCP into Apache Spark for further analysis.
71+
72+
73+
## Instructions for creating an ansible-pcp release:
74+
75+
### On GitHub
76+
77+
1. Pull down the performancecopilot org upstream ansible-pcp repo
78+
2. Bump the version to X.Y.Z in `galaxy.yml`
79+
3. `git add galaxy.yml`
80+
4. `git commit -m "Bump version to X.Y.Z ..."`
81+
5. `git tag -m vX.Y.Z vX.Y.Z`
82+
6. `git push && git push --tags`
83+
7. Navigate to the github web interface
84+
8. Create a new release for the tag vX.Y.Z and set the title to X.Y.Z
85+
86+
### Ansible Galaxy
87+
88+
Still in the performancecopilot ansible-pcp repo:
89+
90+
1. Remove the old `*.tar.gz` file if present
91+
2. `ansible-galaxy collection build`
92+
3. Navigate to https://galaxy.ansible.com/ui/namespaces/performancecopilot/
93+
4. Click "upload collection" and upload the `tar.gz` file just created with the `ansible-galaxy collection build` command
94+

0 commit comments

Comments
 (0)