Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(archiving): Automate workflow updates #2317

Merged
merged 4 commits into from
Jul 11, 2023
Merged

Conversation

pepopowitz
Copy link
Collaborator

@pepopowitz pepopowitz commented Jul 11, 2023

Description

Part of #1173.

This PR automates the CI workflow updates involved in archiving an unsupported version.

See the changes in https://github.com/camunda/camunda-platform-docs/pull/2235/files, specifically within the .github/workflows folder, for a snapshot of all the changes included in this automated step.

When should this change go live?

  • This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
  • There is no urgency with this change.
  • This change or page is part of a marketing blog, conference talk, or something else on a schedule.
  • This functionality is already available but undocumented.
  • This is a bug fix or security concern.

PR Checklist

  • I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
  • I have added changes to the main /docs directory (aka /next/), or they are not for future versions.
  • My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
  • My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

@pepopowitz pepopowitz added kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have) dx Documentation infrastructure typically handled by the Camunda DX team epic:archive-old-versions labels Jul 11, 2023
@pepopowitz pepopowitz requested a review from akeller July 11, 2023 21:16
@pepopowitz pepopowitz self-assigned this Jul 11, 2023
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a lot of sed commands in here! Some (many?) of them could be combined, but I left each step separate, as I think it more clearly lays out what needs to happen.

Copy link
Member

@akeller akeller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really like how you organized this with the comments, steps, and including individual sed commands. It makes something that could otherwise be really difficult to read (as a human) much more digestible.

Looking at how many steps you've automated along the way is super cool too! 👏

Great work here @pepopowitz!

@pepopowitz pepopowitz enabled auto-merge (squash) July 11, 2023 21:28
@pepopowitz pepopowitz merged commit 0af6f6e into main Jul 11, 2023
8 checks passed
@pepopowitz pepopowitz deleted the automate-workflow-updates branch July 11, 2023 21:37
@pepopowitz
Copy link
Collaborator Author

Oh I forgot to mention that chatGPT helped me with many/most of these sed commands. 🤖

It did get some things wrong....but it was much more helpful than harmful.

@akeller
Copy link
Member

akeller commented Jul 11, 2023

So generous of you to give credit where credit is due!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dx Documentation infrastructure typically handled by the Camunda DX team epic:archive-old-versions kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have)
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants