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

Adding colophon page for license, DOI and citation #570

Merged
merged 48 commits into from
Dec 3, 2024

Conversation

cofinoa
Copy link
Contributor

@cofinoa cofinoa commented Nov 14, 2024

See issue #513 for discussion of these changes.

This replaces PR #514 and PR #507

Note: This PR is based on pending changes for PR #568

Release checklist

  • [] Authors updated in cf-conventions.adoc? Add in two places: on line 3 and under .Additional Authors in About the authors.
  • Next version in cf-conventions.adoc up to date? Versioning inspired by SemVer.
  • history.adoc up to date?
  • 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 CF1.12? We might conclude this issue in time for CF1.12 enhancement Proposals to add new capabilities, improve existing ones in the conventions, improve style or format GitHub Improvement to how we use GitHub for this repository labels Nov 14, 2024
cf-conventions.adoc Outdated Show resolved Hide resolved
cf-conventions.adoc Outdated Show resolved Hide resolved
…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 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.
- 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.
CITATION.cff Outdated Show resolved Hide resolved
@cofinoa cofinoa marked this pull request as ready for review December 2, 2024 13:23
@cofinoa cofinoa self-assigned this Dec 2, 2024
@larsbarring larsbarring force-pushed the add-colophon-doi-citation branch from 45ee3cf to 9be2f79 Compare December 3, 2024 10:16
Copy link
Contributor

@larsbarring larsbarring left a comment

Choose a reason for hiding this comment

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

I am not an expert on the more technical aspects of the gh workflow machinery, but to me this looks all good.

@cofinoa cofinoa merged commit bb13307 into cf-convention:main Dec 3, 2024
2 checks passed
@JonathanGregory JonathanGregory linked an issue Dec 3, 2024 that may be closed by this pull request
@cofinoa cofinoa deleted the add-colophon-doi-citation branch December 4, 2024 10:28
@davidhassell davidhassell added this to the 1.12 milestone Dec 4, 2024
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 enhancement Proposals to add new capabilities, improve existing ones in the conventions, improve style or format GitHub Improvement to how we use GitHub for this repository
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Include DOI and License information in the conventions document
3 participants