summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSarabraj Singh <sarsingh@redhat.com>2022-07-12 22:19:25 +0200
committerSarabraj Singh <sarsingh@redhat.com>2022-07-14 20:13:18 +0200
commitcd2fae3471f18f6a120851dc7454754650f32845 (patch)
tree5b6481211378bf2d26adccf6285290287bcc16ad
parentMerge pull request #12505 from sarabrajsingh/bugfix/add-setuptools-scm-depend... (diff)
downloadawx-cd2fae3471f18f6a120851dc7454754650f32845.tar.xz
awx-cd2fae3471f18f6a120851dc7454754650f32845.zip
buffed docs for AWX Release and canonical Triage responses
-rw-r--r--.github/triage_replies.md22
-rw-r--r--docs/img/revert-1.pngbin0 -> 82455 bytes
-rw-r--r--docs/img/revert-2.pngbin0 -> 76213 bytes
-rw-r--r--docs/img/tag-revert-1.pngbin0 -> 42498 bytes
-rw-r--r--docs/release_process.md31
5 files changed, 42 insertions, 11 deletions
diff --git a/.github/triage_replies.md b/.github/triage_replies.md
index 384c72ceb3..af75cd347d 100644
--- a/.github/triage_replies.md
+++ b/.github/triage_replies.md
@@ -1,5 +1,5 @@
## General
-- For the roundup of all the different mailing lists available from AWX, Ansible, and beyond visit: https://docs.ansible.com/ansible/latest/community/communication.html
+- For the roundup of all the different mailing lists available from AWX, Ansible, and beyond visit: https://docs.ansible.com/ansible/latest/community/communication.html
- Hello, we think your question is answered in our FAQ. Does this: https://www.ansible.com/products/awx-project/faq cover your question?
- You can find the latest documentation here: https://docs.ansible.com/automation-controller/latest/html/userguide/index.html
@@ -58,10 +58,10 @@ Thank you once again for this and your interest in AWX!
## Common
### Give us more info
-- Hello, we'd love to help, but we need a little more information about the problem you're having. Screenshots, log outputs, or any reproducers would be very helpful.
+- Hello, we'd love to help, but we need a little more information about the problem you're having. Screenshots, log outputs, or any reproducers would be very helpful.
### Code of Conduct
-- Hello. Please keep in mind that Ansible adheres to a Code of Conduct in its community spaces. The spirit of the code of conduct is to be kind, and this is your friendly reminder to be so. Please see the full code of conduct here if you have questions: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html
+- Hello. Please keep in mind that Ansible adheres to a Code of Conduct in its community spaces. The spirit of the code of conduct is to be kind, and this is your friendly reminder to be so. Please see the full code of conduct here if you have questions: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html
### EE Contents / Community General
- Hello. The awx-ee contains the collections and dependencies needed for supported AWX features to function. Anything beyond that (like the community.general package) will require you to build your own EE. For information on how to do that, see https://ansible-builder.readthedocs.io/en/stable/ \
@@ -79,31 +79,31 @@ The Ansible Community is looking at building an EE that corresponds to all of th
- Hello, we think your idea is good! Please consider contributing a PR for this following our contributing guidelines: https://github.com/ansible/awx/blob/devel/CONTRIBUTING.md
### Receptor
-- You can find the receptor docs here: https://receptor.readthedocs.io/en/latest/
+- You can find the receptor docs here: https://receptor.readthedocs.io/en/latest/
- Hello, your issue seems related to receptor. Could you please open an issue in the receptor repository? https://github.com/ansible/receptor. Thanks!
### Ansible Engine not AWX
-- Hello, your question seems to be about Ansible development, not about AWX. Try asking on the Ansible-devel specific mailing list: https://groups.google.com/g/ansible-devel
+- Hello, your question seems to be about Ansible development, not about AWX. Try asking on the Ansible-devel specific mailing list: https://groups.google.com/g/ansible-devel
- Hello, your question seems to be about using Ansible, not about AWX. https://groups.google.com/g/ansible-project is the best place to visit for user questions about Ansible. Thanks!
### Ansible Galaxy not AWX
- Hey there. That sounds like an FAQ question. Did this: https://www.ansible.com/products/awx-project/faq cover your question?
### Contributing Guidelines
-- AWX: https://github.com/ansible/awx/blob/devel/CONTRIBUTING.md
+- AWX: https://github.com/ansible/awx/blob/devel/CONTRIBUTING.md
- AWX-Operator: https://github.com/ansible/awx-operator/blob/devel/CONTRIBUTING.md
### AWX Release
-Subject: Announcing AWX X.Y.z
+Subject: Announcing AWX Xa.Ya.za and AWX-Operator Xb.Yb.zb
- Hi all, \
\
-We're happy to announce that the next release of AWX, version <X> is now available! \
-In addition AWX Operator version <Y> has also been release! \
+We're happy to announce that the next release of AWX, version <b>`Xa.Ya.za`</b> is now available! \
+In addition AWX Operator version <b>`Xb.Yb.zb`</b> has also been released! \
\
Please see the releases pages for more details: \
- AWX: https://github.com/ansible/awx/releases/tag/<X> \
- Operator: https://github.com/ansible/awx-operator/releases/tag/<Y> \
+ AWX: https://github.com/ansible/awx/releases/tag/Xa.Ya.za \
+ Operator: https://github.com/ansible/awx-operator/releases/tag/Xb.Yb.zb \
\
The AWX team.
diff --git a/docs/img/revert-1.png b/docs/img/revert-1.png
new file mode 100644
index 0000000000..17f36512dd
--- /dev/null
+++ b/docs/img/revert-1.png
Binary files differ
diff --git a/docs/img/revert-2.png b/docs/img/revert-2.png
new file mode 100644
index 0000000000..cf91a36b1a
--- /dev/null
+++ b/docs/img/revert-2.png
Binary files differ
diff --git a/docs/img/tag-revert-1.png b/docs/img/tag-revert-1.png
new file mode 100644
index 0000000000..29447c95f4
--- /dev/null
+++ b/docs/img/tag-revert-1.png
Binary files differ
diff --git a/docs/release_process.md b/docs/release_process.md
index d31d13daa4..82a297303c 100644
--- a/docs/release_process.md
+++ b/docs/release_process.md
@@ -2,6 +2,7 @@
The release process for AWX is completely automated as of version 19.5.0.
+If you need to revert a release, please refer to the [Revert a Release](#revert-a-release) section.
## Get latest release version and list of new work
1. Open the main project page for [AWX](https://github.com/ansible/awx/releases) and [AWX Operator](https://github.com/ansible/awx-operator/releases).
@@ -135,3 +136,33 @@ We're happy to announce that [AWX version 21.1.0](https://github.com/ansible/awx
We're happy to announce that [AWX Operator version 0.22.0](https://github.com/ansible/awx-operator/releases/tag/0.22.0) is now available!
## Send the same IRC message (less the @newsbot) to #awx:ansible.com
+
+## Revert a Release
+
+Decide whether or not you can just fall-forward with a new AWX Release to fix a bad release. If you need to remove published artifacts from publically facing repositories, follow the steps below.
+
+Here are the steps needed to revert an AWX and an AWX-Operator release. Depending on your use case, follow the steps for reverting just an AWX release, an Operator release or both.
+
+
+1. Navigate to the [AWX Release Page](https://github.com/ansible/awx/releases) and delete the AWX Release that needs to be removed.
+
+![Revert-1-Image](img/revert-1.png)
+
+2. Navigate to the [AWX Tags Page](https://github.com/ansible/awx/tags) and delete the AWX Tag that got created by the Github Actions Workflow from when you originally tried to release AWX. You need delete the release in step 1 before you can do this step. The tag must not be tied to a release if you want to delete a tag.
+
+![Tag-Revert-1-Image](img/tag-revert-1.png)
+[comment]: <> (Need an image here for actually deleting an orphaned tag, place here during next release)
+
+3. Navigate to the [AWX Operator Release Page]() and delete the AWX-Operator release that needss to tbe removed.
+
+![Revert-2-Image](img/revert-2.png)
+
+4. Navigate to [quay.io](https://quay.io/repository/ansible/awx?tag=latest&tab=tags) and delete the published AWX image(s) and tags.
+
+5. Navigate to [quay.io](https://github.com/ansible/awx-operator/releases) and delete the published AWX Operator image(s) and tags.
+
+6. Navigate to the [Ansible Galaxy Collections](https://galaxy.ansible.com/awx/awx) website and remove the published AWX collection with the bad tag.
+
+7. Navigate to the [PyPi](https://pypi.org/project/awxkit/#history) and delete the bad AWX tag and release that got published.
+
+8. [Restart the Release Process](#releasing-awx-and-awx-operator) \ No newline at end of file