From f762c55d8cf46656d7eda5fdb88204fd5f640ff9 Mon Sep 17 00:00:00 2001 From: Paul Madden Date: Wed, 31 Jan 2024 19:07:45 +0000 Subject: [PATCH 1/5] Remove references to develop branch --- .github/workflows/test.yaml | 3 --- README.md | 2 +- docs/sections/contributor_guide/documentation.rst | 4 ++-- docs/sections/contributor_guide/fork_pr_model.rst | 2 +- 4 files changed, 4 insertions(+), 7 deletions(-) diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 2113b3b9e..8ba0163d9 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -2,15 +2,12 @@ name: Test on: pull_request: branches: - - develop - main push: branches: - - develop - main workflow_dispatch: branches: - - develop - main jobs: test: diff --git a/README.md b/README.md index 17e14ef57..5b74e903d 100644 --- a/README.md +++ b/README.md @@ -6,4 +6,4 @@ Unified Workflow Tools for use with UFS applications and beyond ## Documentation -Comprehensive documentation is available for [the development version](https://uwtools.readthedocs.io/en/develop/) and for [the latest release](https://uwtools.readthedocs.io/en/main/). +Comprehensive documentation is available for [the development version](https://uwtools.readthedocs.io/en/main/) and for [the latest release](https://uwtools.readthedocs.io/en/stable/). diff --git a/docs/sections/contributor_guide/documentation.rst b/docs/sections/contributor_guide/documentation.rst index 800f0b950..1a2b3bce2 100644 --- a/docs/sections/contributor_guide/documentation.rst +++ b/docs/sections/contributor_guide/documentation.rst @@ -24,9 +24,9 @@ If, at some point, you remove and recreate the conda development environment und Viewing Online Documentation ---------------------------- -Online documentation generation and hosting for ``uwtools`` is provided by :rtd:`Read the Docs<>`. The green *View Docs* button near the upper right of that page links to the official docs for the project, as built for the ``main`` branch. Docs are also generated for the ``develop`` branch and can be selected by changing **v: main** to **v: develop** via the small green pull-down menu located at the bottom of the navigation pane on the left of the page. +Online documentation generation and hosting for ``uwtools`` is provided by :rtd:`Read the Docs<>`. The green *View Docs* button near the upper right of that page links to the official docs for the project. When viewing the documentation, the version selector at the bottom of the navigation column on the left can be used to switch between the latest development code (``main``), the latest released version (``stable``), and any previously released version. -Docs are also built and published when Pull Requests (PRs) targeting the ``develop`` or ``main`` branches are opened. Visit the :rtd:`Builds page` to see recent builds, including those made for PRs. Click a PR-related build marked *Passed*, then the small *View docs* link (**not** the large green *View Docs* button) to see the docs built specifically for that PR. If your PR includes documentation updates, it may be helpful to include the URL of this build in your PR's description so that reviewers can see the rendered HTML docs and not just the modified ``.rst`` files. Note that if commits are pushed to the PR's source branch, Read the Docs will rebuild the PR docs. See the checks section near the bottom of a PR for current status, and for another link to the PR docs via the *Details* link. +Docs are also built and temporarily published when Pull Requests (PRs) targeting the ``main`` branch are opened. Visit the :rtd:`Builds page` to see recent builds, including those made for PRs. Click a PR-related build marked *Passed*, then the small *View docs* link (**not** the large green *View Docs* button) to see the docs built specifically for that PR. If your PR includes documentation updates, it may be helpful to include the URL of this build in your PR's description so that reviewers can see the rendered HTML docs and not just the modified ``.rst`` files. Note that if commits are pushed to the PR's source branch, Read the Docs will rebuild the PR docs. See the checks section near the bottom of a PR for current status, and for another link to the PR docs via the *Details* link. Documentation Guidelines ------------------------ diff --git a/docs/sections/contributor_guide/fork_pr_model.rst b/docs/sections/contributor_guide/fork_pr_model.rst index 3a3ffa400..80415e81f 100644 --- a/docs/sections/contributor_guide/fork_pr_model.rst +++ b/docs/sections/contributor_guide/fork_pr_model.rst @@ -19,7 +19,7 @@ Specifics for ``uwtools`` When creating your PR, please follow these guidelines, specific to the ``uwtools`` project: -* Ensure that your PR is targeting base repository ``ufs-community/uwtools`` and base branch ``develop``. +* Ensure that your PR is targeting base repository ``ufs-community/uwtools`` and base branch ``main``. * Your PR's **Add a description** field will appear pre-populated with a template that you should complete. Provide an informative synopsis of your contribution, then mark appropriate checklist items by placing an "x" between their square brackets. You may tidy up the description by removing boilerplate text and non-selected checklist items. * Use the pull-down arrow on the green button below the description to initially create a :github-docs:`draft pull request`. * Once your draft PR is open, visit its **Files changed** tab and add comments on any lines of code that you think reviewers will benefit from. Try to save time by proactively answering questions you suspect reviewers will ask. From ff4e7d4d0398a991ea200e2cea61bb07ad0a6c96 Mon Sep 17 00:00:00 2001 From: Paul Madden Date: Wed, 31 Jan 2024 19:14:27 +0000 Subject: [PATCH 2/5] Update tag logic --- .github/scripts/common.sh | 4 ++++ .github/scripts/tag-check.sh | 4 ++-- .github/scripts/tag-create.sh | 4 ++-- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/scripts/common.sh b/.github/scripts/common.sh index a1fa7255e..e24ae7c09 100644 --- a/.github/scripts/common.sh +++ b/.github/scripts/common.sh @@ -7,3 +7,7 @@ ci_conda_activate() { source $CI_CONDA_SH conda activate } + +ci_tag() { + echo $(jq -r .version recipe/meta.json) +} diff --git a/.github/scripts/tag-check.sh b/.github/scripts/tag-check.sh index b79986395..ef30a9eef 100755 --- a/.github/scripts/tag-check.sh +++ b/.github/scripts/tag-check.sh @@ -1,8 +1,8 @@ # Actions invokes script with: bash -e