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

Updating build process and gh-pages fork publications #568

Merged
merged 23 commits into from
Dec 2, 2024
Merged

Updating build process and gh-pages fork publications #568

merged 23 commits into from
Dec 2, 2024

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 cofinoa mentioned this pull request Nov 14, 2024
Closed
@cofinoa
Copy link
Contributor Author

cofinoa commented Nov 14, 2024

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

@cofinoa cofinoa mentioned this pull request Nov 14, 2024
Merged
3 tasks
@JonathanGregory JonathanGregory linked an issue Nov 14, 2024 that may be closed by this pull request
Enhance GitHub Actions: Publish PR and Push Previews as Artifacts to Release Assets and GitHub Pages #569
Closed
@JonathanGregory JonathanGregory added this to the 1.12 milestone Nov 14, 2024
cofinoa added 16 commits November 18, 2024 13:06
@cofinoa
Adding working directories to gh-pages
dcbcc9d
@cofinoa
Fix sed expressions
34f5f44
@cofinoa
Escaping path sep in sed expressions
992746a
@cofinoa
FIx sed expressions
143fa19
@cofinoa
Adding sudo
81e5d77
@cofinoa
Fixing typo on else
0c0e97c
@cofinoa
Improve push events
0436c55
@cofinoa
Ignore README
6c8fe9b
@cofinoa
Refactor GitHub Actions Workflow: Centralize configuration with envir…
bb38303 
…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.
@cofinoa
Fix typos
13cd42a
@cofinoa
Update adoc_build.yml
5a1042a
@cofinoa
Update adoc_build.yml
8052590
@cofinoa
Update adoc_build.yml
5cdbbfe
@cofinoa
Publish assest to release
d056a75
@cofinoa
Comment condensed
b8045f0
@cofinoa
Renaming GH action file workflow
ce71e51
@cofinoa
Improve Workflow: PR Event Handling and Cleanup
df05d05 
- 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.
@cofinoa
Update events and clean-up
c01ed60
@cofinoa cofinoa mentioned this pull request Nov 29, 2024
Closed
@cofinoa
Move prepare and build index publish_doc
6992c18
@cofinoa
Enhance GitHub Actions workflow to handle PR-specific logic
66fa749 
- Skip the `publish_docs` job when the event is a Pull Request.
- Add artifact upload link as a sticky comment in PRs.
- Ensure `build_docs` and `publish_docs` jobs work for non-PR events (e.g., push, release).
- Improve conditional logic for handling event types in the workflow.
@cofinoa
Remove sticky comment functionality for PR artifact linking
b73d3f7 
- Removed `marocchino/sticky-pull-request-comment` step for PR events.
- Added explicit artifact link output in the workflow logs.
- Simplified workflow by guiding users to download artifacts via the Actions run page.
@cofinoa
Merge remote-tracking branch 'upstream/main'
c539435
@cofinoa cofinoa merged commit a4185dd into cf-convention:main Dec 2, 2024
2 checks passed
@cofinoa
Copy link
Contributor Author

cofinoa commented Dec 2, 2024

Ready!! let's merge.

@JonathanGregory JonathanGregory linked an issue Dec 3, 2024 that may be closed by this pull request
Clean up the gh-pages branch #571
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JonathanGregory JonathanGregory JonathanGregory approved these changes

Assignees
No one assigned
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
Milestone
1.12
2 participants
@cofinoa @JonathanGregory