Skip to content

Commit

Permalink
1.14.1 release NRLMMD-GEOIPS/geoips#740
Browse files Browse the repository at this point in the history
  • Loading branch information
mindyls committed Sep 30, 2024
1 parent 2340ecf commit e98820c
Show file tree
Hide file tree
Showing 88 changed files with 2,429 additions and 723 deletions.
12 changes: 12 additions & 0 deletions .flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[flake8]
max-line-length=88
count=True
ignore=E203,W503,E712
extend-exclude=_version.py,lib,*_docs,geoips_dev_utils
docstring-convention=numpy
rst-roles=class,func,ref
rst-directives=envvar,exception
rst-substitutions=version
statistics=True
per-file-ignores =
/*/interfaces/__init__.py:F401
60 changes: 60 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
changelog:
categories:
- title: Breaking Changes 🛠
labels:
- "breaking change"
- "api change"
- "deprecation"
- title: Security Updates
labels:
- "security"
- title: Exciting New Features 🎉
labels:
- "enhancement"
- "new functionality"
- "new feature"
- title: Deprecations
labels:
- "deprecation"
- title: Regression Fixes
labels:
- "regression"
- title: Bug Fixes
labels:
- "bug"
- title: Efficiency Improvements
labels:
- "efficiency"
- title: Installation Updates
labels:
- "installation"
- title: Real-time Processing Improvements
labels:
- "real-time processing"
- title: Code Formatting / Style / Refactoring Updates
labels:
- "formatting"
- "refactor"
- title: GitHub Actions Updates
labels:
- "actions"
- title: Git Workflow Improvements
labels:
- "git workflow"
- title: Testing Updates
labels:
- "testing"
- "code checks"
- "test repo updates"
- title: Documentation Updates
labels:
- "documentation"
- title: Changes During Release Process
labels:
- "Version Release"
- title: Developmental Updates
labels:
- "Dev Update"
- title: Other Changes
labels:
- "*"
25 changes: 25 additions & 0 deletions .github/workflows/brassy-notes.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Brassy

on:
# Triggers the workflow when pull request closed (either closed
# as non-planned, or actually approved and merged.)
pull_request:
types:
- closed
branch: main
# Allows run of this workflow manually from the Actions tab
# Must be merged to default before it will be available to manually run.
workflow_dispatch:

jobs:
brassy-notes:
name: Brassy
# You do not appear to be able to use variables in the "uses" field.
uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-brassy-notes.yaml@main
# Only run this if the pull request was merged, not just closed.
if: github.event.pull_request.merged == true
permissions:
contents: write
pull-requests: write
secrets:
token: ${{ secrets.GEOIPS_TOKEN }}
36 changes: 36 additions & 0 deletions .github/workflows/deploy-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Deploy docs

# 1. Brassy - on merge of v*-version-release
# * generate release notes
# * commit and push to v*-add-rst-release-note
# * open PR to default branch
# 2. Tag and Release - on merge of v*-add-rst-release-note
# * Tag current version
# * Release just tagged version
# 3. Package and Publish - on published release (from #2)
# * Build wheel
# * Publish to pypi
# 4. Deploy docs - on published release (from #2)
# * pip install geoips
# * pip install plugin repo
# * build docs with geoips/docs/build_docs.sh
# * deploy docs with geoips/docs/deploy_pages.sh

on:
# Triggers the workflow on published release
release:
types:
- published
# Allows run of this workflow manually from the Actions tab
# Must be merged to default before it will be available to manually run.
workflow_dispatch:

jobs:
deploy-docs:
name: Deploy docs
# You do not appear to be able to use variables in the "uses" field.
uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-deploy-docs.yaml@main
permissions:
contents: write
secrets:
token: ${{ secrets.GEOIPS_TOKEN }}
18 changes: 18 additions & 0 deletions .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Lint

# Only run linting on pull requests
on:
# Triggers the workflow when pull request created and updated
pull_request:
# Allows run of this workflow manually from the Actions tab
workflow_dispatch:

jobs:
lint:
name: Lint
# You do not appear to be able to use variables in the "uses" field.
uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-lint.yaml@main
permissions:
contents: read
secrets:
token: ${{ secrets.GEOIPS_TOKEN }}
38 changes: 38 additions & 0 deletions .github/workflows/package-and-publish.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Package/publish

# 1. Brassy - on merge of v*-version-release
# * generate release notes
# * commit and push to v*-add-rst-release-note
# * open PR to default branch
# 2. Tag and Release - on merge of v*-add-rst-release-note
# * Tag current version
# * Release just tagged version
# 3. Package and Publish - on published release (from #2)
# * Build wheel
# * Publish to pypi
# 4. Deploy docs - on published release (from #2)
# * pip install geoips
# * pip install plugin repo
# * build docs with geoips/docs/build_docs.sh
# * deploy docs with geoips/docs/deploy_pages.sh

on:
# triggers the workflow on published release
release:
types:
- published
# allows run of this workflow manually from the actions tab
# must be merged to default before it will be available to manually run.
workflow_dispatch:

jobs:
package-publish:
name: Package/publish
# You do not appear to be able to use variables in the "uses" field.
uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-package-and-publish.yaml@main
permissions:
contents: read
secrets:
token: ${{ secrets.GEOIPS_TOKEN }}
pypi_user: ${{ secrets.PYPI_USER }}
pypi_password: ${{ secrets.PYPI_PASSWORD }}
16 changes: 16 additions & 0 deletions .github/workflows/proper-release-note-edits.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Note edits

# We only need to check status of release notes from pull requests.
on:
# Triggers the workflow when pull request created and updated
pull_request:
# Allows run of this workflow manually from the Actions tab
workflow_dispatch:

jobs:
note-edits:
name: Note edits
# You do not appear to be able to use variables in the "uses" field.
uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-proper-release-note-edits.yaml@main
permissions:
contents: read
25 changes: 25 additions & 0 deletions .github/workflows/tag-and-release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Tag/release

on:
# Triggers the workflow when pull request closed (either closed
# as non-planned, or actually approved and merged.)
pull_request:
types:
- closed
branch: main
# Allows run of this workflow manually from the Actions tab
# Must be merged to default branch before it will be available
# to manually run.
workflow_dispatch:

jobs:
tag-release:
name: Tag/release
# You do not appear to be able to use variables in the "uses" field.
uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-tag-and-release.yaml@main
# Only run this if the pull request was merged, not just closed.
if: github.event.pull_request.merged == true
permissions:
contents: write
secrets:
token: ${{ secrets.GEOIPS_TOKEN }}
20 changes: 12 additions & 8 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@

# auto-downloaded test datasets
tests/data/**

# directory for profiling outputs
profiling/
*.pstats
# auto-generated command instructions file
geoips/commandline/ancillary_info/cmd_instructions.json
# auto-generated alias mapping file for the cli
geoips/commandline/ancillary_info/alias_mapping.json

####################################################
# GeoIPS Environment specific .gitignore options:

# auto-generated command instructions file
geoips/commandline/ancillary_info/cmd_instructions.json
# auto-generated release note file for latest changes
docs/source/releases/latest.rst
# auto-generated release note files, all release note information
# is stored in .yaml format and the rst files auto-generated.
# index.rst, latest.rst, v*.rst
docs/source/releases/*.rst
# auto-generated plugin registry file
registered_plugins.json
# auto-generated version file, created at run-time
Expand All @@ -31,6 +31,10 @@ _version.py
*.swp
*.simg

# directory for profiling outputs
profiling/
*.pstats

####################################################
# Default auto-generated .gitignore options:

Expand Down
23 changes: 4 additions & 19 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,24 +1,9 @@
| # # # Distribution Statement A. Approved for public release. Distribution unlimited.
| # # #
| # # # Author:
| # # # Naval Research Laboratory, Marine Meteorology Division
| # # #
| # # # This program is free software: you can redistribute it and/or modify it under
| # # # the terms of the NRLMMD License included with this program. This program is
| # # # distributed WITHOUT ANY WARRANTY; without even the implied warranty of
| # # # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the included license
| # # # for more details. If you did not receive the license, for more information see:
| # # # https://github.com/U-S-NRL-Marine-Meteorology-Division/
.. dropdown:: Distribution Statement

| # # # This source code is protected under the license referenced at
| # # # https://github.com/NRLMMD-GEOIPS.
Please see
https://github.com/NRLMMD-GEOIPS/geoips/blob/main/CHANGELOG_TEMPLATE.rst
for instructions on updating release notes appropriately
with each PR.

The release note that is currently, actively being updated in
all geoips plugin repositories is referenced in the file:

* https://github.com/NRLMMD-GEOIPS/geoips/blob/main/update_this_release_note

* Please add all release notes for the current PR in the file referenced
within ``update_this_release note``.
Loading

0 comments on commit e98820c

Please sign in to comment.