Skip to content

Commit

Permalink
UW-493 (#404)
Browse files Browse the repository at this point in the history
  • Loading branch information
maddenp-noaa authored Jan 31, 2024
1 parent 86118dc commit b7c65d8
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 40 deletions.
9 changes: 0 additions & 9 deletions .github/scripts/tag-check.sh

This file was deleted.

7 changes: 0 additions & 7 deletions .github/scripts/tag-create.sh

This file was deleted.

16 changes: 6 additions & 10 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,22 @@ name: Release
env:
ANACONDA_TOKEN: ${{ secrets.ANACONDA_TOKEN }}
on:
push:
workflow_dispatch:
branches:
- main
- '[0-9]+.[0-9]+.[0-9]+'
jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install conda
run: .github/scripts/install-conda.sh
- name: Docs Link Check
run: .github/scripts/install-conda.sh
- name: Documentation Link Check
run: .github/scripts/link-check.sh
- name: Format Check
run: .github/scripts/format-check.sh
run: .github/scripts/format-check.sh
- name: Make Package
run: .github/scripts/make-package.sh
- name: Check For Existing Tag
run: .github/scripts/tag-check.sh
- name: Tag
run: .github/scripts/tag-create.sh
run: .github/scripts/make-package.sh
- name: Publish
run: .github/scripts/publish.sh
17 changes: 7 additions & 10 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,24 @@ name: Test
on:
pull_request:
branches:
- develop
- main
push:
branches:
- develop
- main
workflow_dispatch:
branches:
- develop
- main
- '**'
jobs:
test:
name: Test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install conda
run: .github/scripts/install-conda.sh
- name: Test
run: .github/scripts/test.sh
- name: Format Check
run: .github/scripts/format-check.sh
- name: Docs Link Check
run: .github/scripts/install-conda.sh
- name: Documentation Link Check
run: .github/scripts/link-check.sh
- name: Format Check
run: .github/scripts/format-check.sh
- name: Test
run: .github/scripts/test.sh
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
4 changes: 2 additions & 2 deletions docs/sections/contributor_guide/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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<builds>` 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<builds>` 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
------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/sections/contributor_guide/fork_pr_model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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<pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests>`.
* 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.
Expand Down

0 comments on commit b7c65d8

Please sign in to comment.