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

creates build and pr to gh-page #1644

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

Conversation

psankhe28
Copy link
Contributor

Checklist

  • A link to the issue/user story that the pull request relates to
  • How to recreate the problem without the fix
  • Design of the fix
  • How to prove that the fix works
  • Automated tests that prove the fix keeps on working
  • Documentation - any JSDoc, website, or Stackoverflow answers?

Issue/User story

Steps to Reproduce

Existing issues

Design of the fix

Validation of the fix

Automated Tests

What documentation has been provided for this pull request

@psankhe28 psankhe28 requested a review from a team October 22, 2024 11:57
@davidkel
Copy link
Contributor

davidkel commented Nov 6, 2024

@psankhe28 I don't think this is what we will go with as discussed previously. So here is my suggestions

  1. Submit a PR to the gh-pages branch that replaces the documentation with the new version of docs in the main branch
  2. Write a section in the release_process.md file in main about how to add another version of the docs (for example v1.0.0) to gh-pages via a pull request. The instructions should set that to the default version (but ensure that the 0.6.0 version still remains) and it would then be submitted to gh-pages as a PR manually.

Investigating how mike works the whole of the gh-pages branch content will be managed by mike, therefore we can take a different approach to managing the content which still retains branch protection but allows github actions to automate publication without the need to generate PRs. This is not something that needs investigation at this time though so please don't look into it.

Copy link
Contributor

@davidkel davidkel left a comment

Choose a reason for hiding this comment

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

We aren't going with a PR approach for github actions

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.

2 participants