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.

Sign up for GitHub

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

Jump to bottom

Update GitHub Actions Docs #2533

Merged
merged 1 commit into from
Oct 17, 2024
Merged

Update GitHub Actions Docs #2533

merged 1 commit into from
Oct 17, 2024

Conversation

caitlynstocker
Copy link
Contributor

@caitlynstocker caitlynstocker commented Sep 30, 2024 •
edited
Loading

What's this? 🐪

This change is intended to simplify the documentation for our GitHub Actions. See the existing doc in full here.

What's changed here?

  • Moved the most fundamental info to the top of the doc. (I.e. what are Octopus Actions and how do I use them?)
  • Removed a lot of general info on GitHub Actions and replaced it with links to GitHub's own docs.
  • Removed instructions for using each Octopus Action as this info is duplicated in the docs of the individual actions. Instead, I've listed all available Octopus Actions in one place and provided links for more information.
  • Replaced the existing example with a simpler workflow modelling a common use case - i.e. logging in with OICD, creating a Release, then deploying that Release.
  • Added a simple example of how to create, push and reference a package in a Release.
  • Moved the helpful tips for working with Octopus Actions to the bottom of the page and rewritten these for brevity.
image

How to review 🔍

✅ Any advice for extra things to include / remove?
😎 Here's how to preview the updated doc if you're interested

Fixes[sc-93404]

@caitlynstocker caitlynstocker marked this pull request as draft September 30, 2024 01:23
dylanlerch
dylanlerch reviewed Sep 30, 2024
View reviewed changes
Copy link
Contributor

@dylanlerch dylanlerch left a comment

Choose a reason for hiding this comment

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

Looks good, stripped right back which is fantastic.

src/pages/docs/packaging-applications/build-servers/github-actions.md Outdated Show resolved Hide resolved
src/pages/docs/packaging-applications/build-servers/github-actions.md Outdated Show resolved Hide resolved
src/pages/docs/packaging-applications/build-servers/github-actions.md Outdated Show resolved Hide resolved
src/pages/docs/packaging-applications/build-servers/github-actions.md Outdated Show resolved Hide resolved
caitlynstocker
caitlynstocker commented Sep 30, 2024
View reviewed changes
src/pages/docs/packaging-applications/build-servers/github-actions.md Outdated
| Name | Description |
| :---------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `OCTOPUS_SPACE` | The Name of the Space where this command will be executed. |
| `OCTOPUS_URL` | The base URL hosting Octopus Deploy (i.e. `https://octopus.example.app`). It is strongly recommended that this value retrieved from a [GitHub secret.](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions) |
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Does this value actually need to be a secret? Most of our examples recommend it, but then our OICD login action shows the URL in the example in text. Wasn't sure which to go with here.

@caitlynstocker caitlynstocker force-pushed the cat/93404/update-github-actions-doc branch from a89da53 to d5c0974 Compare September 30, 2024 03:33
@caitlynstocker caitlynstocker changed the title Cat/93404/update GitHub actions doc Update GitHub Actions Docs Sep 30, 2024
@caitlynstocker caitlynstocker marked this pull request as ready for review September 30, 2024 05:45
@caitlynstocker caitlynstocker requested a review from a team September 30, 2024 05:46
mattocto
mattocto reviewed Sep 30, 2024
View reviewed changes
Copy link
Contributor

@mattocto mattocto left a comment

Choose a reason for hiding this comment

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

From the diff, this looks awesome, but I don't have the ability to easily preview it. Maybe we can pair quickly some time this week to talk about it and you can show me a preview of the new version.

@caitlynstocker
Copy link
Contributor Author

caitlynstocker commented Oct 1, 2024 •
edited
Loading

From the diff, this looks awesome, but I don't have the ability to easily preview it. Maybe we can pair quickly some time this week to talk about it and you can show me a preview of the new version.

@mattocto Sure! We have our catchup tomorrow. I can show it to you then :D

MJRichardson
MJRichardson requested changes Oct 1, 2024
View reviewed changes
Copy link
Contributor

@MJRichardson MJRichardson left a comment

Choose a reason for hiding this comment

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

Love the changes in general.

My only suggestion is to re-add dealing with packages to the sample workflow.
e.g. push a package to Octopus and use this when creating a release

src/pages/docs/packaging-applications/build-servers/github-actions.md

### Packaging artifacts
Copy link
Contributor

Choose a reason for hiding this comment

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

In the example workflow, I think it would be nice to keep the push packages step and to create the release using the build packages. This is typically the trickiest part of the integration.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Have added this in below under Handling Packages 😄

Copy link
Contributor

Choose a reason for hiding this comment

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

@MJRichardson are you happy this one is resolved?

steve-fenton-octopus
steve-fenton-octopus requested changes Oct 1, 2024
View reviewed changes
Copy link
Contributor

@steve-fenton-octopus steve-fenton-octopus left a comment

Choose a reason for hiding this comment

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

Just a few title cased headings converted into sentence case :)

src/pages/docs/packaging-applications/build-servers/github-actions.md Outdated Show resolved Hide resolved
src/pages/docs/packaging-applications/build-servers/github-actions.md Outdated Show resolved Hide resolved
src/pages/docs/packaging-applications/build-servers/github-actions.md Outdated Show resolved Hide resolved
src/pages/docs/packaging-applications/build-servers/github-actions.md Outdated Show resolved Hide resolved
src/pages/docs/packaging-applications/build-servers/github-actions.md Outdated Show resolved Hide resolved
@caitlynstocker caitlynstocker force-pushed the cat/93404/update-github-actions-doc branch 2 times, most recently from 3661a85 to 8bdbb24 Compare October 9, 2024 04:07
@caitlynstocker caitlynstocker force-pushed the cat/93404/update-github-actions-doc branch from 8bdbb24 to 173ead1 Compare October 14, 2024 06:06
@caitlynstocker caitlynstocker force-pushed the cat/93404/update-github-actions-doc branch from 173ead1 to 6c6e383 Compare October 17, 2024 01:50
MJRichardson
MJRichardson approved these changes Oct 17, 2024
View reviewed changes
Copy link
Contributor

@MJRichardson MJRichardson left a comment

Choose a reason for hiding this comment

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

Nice!

@caitlynstocker caitlynstocker merged commit ecf04f0 into main Oct 17, 2024
4 checks passed
@caitlynstocker caitlynstocker deleted the cat/93404/update-github-actions-doc branch October 17, 2024 23:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dylanlerch dylanlerch dylanlerch left review comments

@mattocto mattocto mattocto left review comments

@steve-fenton-octopus steve-fenton-octopus steve-fenton-octopus approved these changes

@MJRichardson MJRichardson MJRichardson approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@caitlynstocker @MJRichardson @dylanlerch @mattocto @steve-fenton-octopus