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

Netlify deployment #4130

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Netlify deployment #4130

wants to merge 4 commits into from

Conversation

Himangini
Copy link
Contributor

@Himangini Himangini commented Nov 10, 2023

Part of #4117

What changed?
Deployment workflow to deploy documentation over Netlify when release happens.
Todo - Test over a production branch

Why was this change made?
See issue

How was this change implemented?

How did you validate the change?
Testing deployment manually with Netlify + deploy previews

Release notes
Todo

Documentation Changes
Todo

@Himangini Himangini added documentation Improvements or additions to documentation ci labels Nov 10, 2023
Copy link
Contributor

@enekofb enekofb left a comment

Choose a reason for hiding this comment

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

Looked at the PR but I think I might miss some context to review:

looked to the referenced issue where mentioned

Add a new workflow for documentation deployment for Netlify

but could not understand the expected AC for the workflow. please let me know more about it. For example, is under scope the development or staging?

Also, could you add some info about how validation happened?

Copy link
Member

@makkes makkes left a comment

Choose a reason for hiding this comment

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

I suppose the only way we can actually test this new workflow is by merging it, as with most other changes in GHA.

@Himangini can you set up deploy previews in Netlify so that we can already see the results here?

jobs:
publish-docs:
name: Publish docs to Netlify
if: ${{ !github.event.release.prerelease }}
Copy link
Member

Choose a reason for hiding this comment

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

Will this work when manually running the workflow?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah, it should work.

run: |
git config --global user.email "corporate-it+weaveworks-docs-bot@weave.works"
git config --global user.name "weaveworks-docs-bot"
git switch docs-production
Copy link
Member

Choose a reason for hiding this comment

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

I suppose the way you imagine hotfixes to the docs to land on the website is to issue PRs against docs-production which is ok in my opinion. That way we can use main as dev branch for the next release. But we need to cleary document this new process.

@Himangini
Copy link
Contributor Author

I suppose the only way we can actually test this new workflow is by merging it, as with most other changes in GHA.

@Himangini can you set up deploy previews in Netlify so that we can already see the results here?

@makkes the deploy preview is set up.

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

Successfully merging this pull request may close these issues.

None yet

3 participants