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

chore: automate devcenter documentation updates #2774

Draft
wants to merge 21 commits into
base: main
Choose a base branch
from

Conversation

k80bowman
Copy link
Contributor

@k80bowman k80bowman commented Apr 4, 2024

This PR completes the github action for updating our devcenter CLI commands documentation. Once we are sure this works, I will add it to our deploy workflows.

Notes

  • There is a problem with all but one of the v5 plugins where the oclif readme command does not add the link to the code for each command in the CLI repo. This should be resolved when we release v9 of the CLI, so we have decided to leave it for now.
  • This adds listings for the plugins:install, plugins:uninstall, and version commands that were not previously included.

Testing

Before pushing the new documentation to devcenter

  • Check the artifact in this workflow run and validate that it contains the correct commands.

Copy link
Contributor

@justinwilaby justinwilaby left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@eablack eablack left a comment

Choose a reason for hiding this comment

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

LGTM. couple questions just verifying things. but yeah, great work!

@@ -25,7 +25,7 @@
"@heroku-cli/schema": "^1.0.25",
"@heroku/buildpack-registry": "^1.0.1",
"@heroku/eventsource": "^1.0.7",
"@oclif/core": "^2.8.11",
"@oclif/core": "^2.16.0",
Copy link
Contributor

Choose a reason for hiding this comment

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

Somewhat significant jump in oclif/core but I don't see much in the changelog that we should be worried about. I noticed 2.16 was released literally yesterday (doesn't even show up in the changelog yet, heh). I think you had described to me something that the oclif team fixed that you asked about. Is that the update with 2.16?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes. They released a fix for us that allows for hidden aliases. We need it for the v9 release as well, so this was really helpful.

- name: Compile documentation and push to devcenter
run: |
cd packages/cli
./scripts/postrelease/dev_center_docs
Copy link
Contributor

Choose a reason for hiding this comment

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

At the end of this it runs devcenter push /tmp/heroku-cli-commands.md.. were you able to test that this works by running this on your local machine (and doing gem install devcenter)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That is my next step. I just wanted someone else to look over all of this first before running that script.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants