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

Updating build process and gh-pages fork publications #568

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

Conversation

cofinoa
Copy link
Contributor

@cofinoa cofinoa commented Nov 14, 2024

No issue for discussion of these changes.

Release checklist

  • [NA ] Authors updated in cf-conventions.adoc? Add in two places: on line 3 and under .Additional Authors in About the authors.
  • [NA] Next version in cf-conventions.adoc up to date? Versioning inspired by SemVer.
  • [NA] history.adoc up to date?
  • [NA] Conformance document up to date?

For maintainers

After the merge remember to delete the source branch.
Tags are set at the conclusion of the annual meeting; until then, main always is a draft for the next version.

@cofinoa cofinoa added GitHub Improvement to how we use GitHub for this repository change agreed Issue accepted for inclusion in the next version and closed CF1.12? We might conclude this issue in time for CF1.12 labels Nov 14, 2024
@cofinoa
Copy link
Contributor Author

cofinoa commented Nov 14, 2024

@JonathanGregory I’m integrating technical changes to build the documents and publish artifacts on the gh-pages branch for forked repositories. I usually merge these changes directly, but since we are in the final cycle for releasing version 1.12, I think an additional review would be beneficial as a precaution.

@JonathanGregory JonathanGregory removed the change agreed Issue accepted for inclusion in the next version and closed label Nov 14, 2024
@JonathanGregory
Copy link
Contributor

Thanks, @cofinoa. As you know, I don't speak this language! You may be the only fluent speaker. However, as far as I can tell, it looks fine. I think it would be good to have an issue (labelled GitHub) for this change, not only to record that it's happened, but also to advertise it, because your skilful work on this will be useful to all authors of modifications. I have removed the change agreed label, because that is one we add to concluded issues, once they've met the criterion for acceptance.

@cofinoa
Copy link
Contributor Author

cofinoa commented Nov 14, 2024

@JonathanGregory I have opened a related issue #569 to this PR

…onment variables

- Introduced environment variables for desired branch, path, and build type:
  - DESIRED_BRANCH: "gh-pages"
  - DESIRED_PATH: "/"
  - DESIRED_BUILD_TYPE: "legacy"
- Simplified configuration management for GitHub Pages enforcement.
- Improved maintainability by reducing hardcoded values across steps.
- Ensured dynamic usage of environment variables in branch creation, artifact handling, and GitHub Pages setup.
- Skip `build_docs` job when the pull request event type is `closed`.
- Add `cleanup_docs` job to remove associated artifacts from the `gh-pages` branch for closed PRs.
- Ensure `publish_docs` job depends on `build_docs` and skips execution for closed PRs.
- Refine `TARGET_DIR` logic for PR previews to ensure proper organization.
- Improve workflow efficiency by avoiding unnecessary builds and deployments.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CF1.12? We might conclude this issue in time for CF1.12 GitHub Improvement to how we use GitHub for this repository
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhance GitHub Actions: Publish PR and Push Previews as Artifacts to Release Assets and GitHub Pages
2 participants