Skip to content

Commit

Permalink
1.14.1 template_basic_plugin - VERSION RELEASE - CI sync (#31)
Browse files Browse the repository at this point in the history
* 1.14.1 release NRLMMD-GEOIPS/geoips#740

* GEOIPS_TOKEN->GITHUB_TOKEN

* Update 0.1.0.yaml

Signed-off-by: mindyls <[email protected]>

* Update 0.1.0.yaml

Signed-off-by: mindyls <[email protected]>

---------

Signed-off-by: mindyls <[email protected]>
  • Loading branch information
mindyls authored Oct 15, 2024
1 parent cf9695f commit 45bdb96
Show file tree
Hide file tree
Showing 17 changed files with 380 additions and 132 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
1 change: 1 addition & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ changelog:
labels:
- "testing"
- "code checks"
- "test repo updates"
- title: Documentation Updates
labels:
- "documentation"
Expand Down
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.GITHUB_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.GITHUB_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.GITHUB_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.GITHUB_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.GITHUB_TOKEN }}
18 changes: 18 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
####################################################
# geoips package specific .gitignore options:

# auto-downloaded test datasets
tests/data/**
# 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 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 @@ -17,6 +31,10 @@ _version.py
*.swp
*.simg

# directory for profiling outputs
profiling/
*.pstats

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

Expand Down
98 changes: 98 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# # # This source code is protected under the license referenced at
# # # https://github.com/NRLMMD-GEOIPS.

# Contributor Covenant Code of Conduct

This Code of Conduct is maintained and enforced by our community collaborators,
and not the Federal Government and its employees.

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement via our contact
information at `docs/source/new-docs/contact.rst`.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Enforcement guidelines have been removed. Discussion is required to determine
how we will handle enforcement. In the mean time, we will endeavor to abide by
the Enforcement Responsibilities described above.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
2 changes: 2 additions & 0 deletions bandit.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
exclude:
- build/
11 changes: 0 additions & 11 deletions docs/source/introduction/index.rst

This file was deleted.

18 changes: 0 additions & 18 deletions docs/source/releases/index.rst

This file was deleted.

Loading

0 comments on commit 45bdb96

Please sign in to comment.