diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 1718a68e..35ca6435 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,2 +1,2 @@ # These owners will be requested for review when someone opens a pull request. -* @ASFHyP3/documentation +* @ASFHyP3/Tools @ASFHyP3/SciDev @ASFHyP3/Services diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 82990ed2..f95d8a5c 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -5,6 +5,12 @@ version: 2 updates: + - package-ecosystem: pip + directory: / + schedule: + interval: weekly + labels: + - bumpless - package-ecosystem: github-actions directory: / schedule: diff --git a/.github/workflows/check-links.yml b/.github/workflows/check-links.yml index 986d40c1..081cefe5 100644 --- a/.github/workflows/check-links.yml +++ b/.github/workflows/check-links.yml @@ -13,9 +13,9 @@ jobs: - name: Link Checker id: lychee - uses: lycheeverse/lychee-action@v2.1.0 + uses: lycheeverse/lychee-action@v2.2.0 env: GITHUB_TOKEN: ${{secrets.TOOLS_BOT_PAK}} with: - args: --insecure "docs/**/*.md" "README.md" "CODE_OF_CONDUCT.md" + args: --insecure "docs/**/*.md" "README.md" fail: true diff --git a/.github/workflows/update_asf_tools_version.yml b/.github/workflows/update_asf_tools_version.yml index 08fa19d1..d17d8b0c 100644 --- a/.github/workflows/update_asf_tools_version.yml +++ b/.github/workflows/update_asf_tools_version.yml @@ -40,7 +40,6 @@ jobs: run: | gh pr create --title "${PR_TITLE}" \ --body "${PR_BODY}" \ - --assignee ASFHyP3/tools \ --label tools-bot \ --head ${{ steps.patch.outputs.branch }} \ --base main diff --git a/.github/workflows/update_sdk_version.yml b/.github/workflows/update_sdk_version.yml index 1146e951..7c078f7e 100644 --- a/.github/workflows/update_sdk_version.yml +++ b/.github/workflows/update_sdk_version.yml @@ -40,7 +40,6 @@ jobs: run: | gh pr create --title "${PR_TITLE}" \ --body "${PR_BODY}" \ - --assignee ASFHyP3/tools \ --label tools-bot \ --head ${{ steps.patch.outputs.branch }} \ --base main diff --git a/CHANGELOG.md b/CHANGELOG.md index fdc32f90..0dabeda1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [PEP 440](https://www.python.org/dev/peps/pep-0440/) and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.9.14] + +### Changed +* Replace Code of Conduct with links to the [organization Code of Conduct](https://github.com/ASFHyP3/.github/blob/main/CODE_OF_CONDUCT.md). + ## [0.9.13] ### Changed diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index 091d0be4..00000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,125 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -We as members, contributors, and leaders pledge to make participation in our -community a harassment-free experience for everyone. - -We pledge to act and interact in ways that contribute to an open, welcoming, -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 e-mail 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 by emailing the -ASF APD/Tools team at [UAF-asf-apd@alaska.edu](mailto:UAF-asf-apd@alaska.edu). -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 - -Community leaders will follow these Community Impact Guidelines in determining -the consequences for any action they deem in violation of this Code of Conduct: - -### 1. Correction - -**Community Impact**: Use of inappropriate language or other behavior deemed -unprofessional or unwelcome in the community. - -**Consequence**: A private, written warning from community leaders, providing -clarity around the nature of the violation and an explanation of why the -behavior was inappropriate. A public apology may be requested. - -### 2. Warning - -**Community Impact**: A violation through a single incident or series -of actions. - -**Consequence**: A warning with consequences for continued behavior. No -interaction with the people involved, including unsolicited interaction with -those enforcing the Code of Conduct, for a specified period of time. This -includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or -permanent ban. - -### 3. Temporary Ban - -**Community Impact**: A serious violation of community standards, including -sustained inappropriate behavior. - -**Consequence**: A temporary ban from any sort of interaction or public -communication with the community for a specified period of time. No public or -private interaction with the people involved, including unsolicited interaction -with those enforcing the Code of Conduct, is allowed during this period. -Violating these terms may lead to a permanent ban. - -### 4. Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an -individual, or aggression toward or disparagement of classes of individuals. - -**Consequence**: A permanent ban from any sort of public interaction within -the community. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 2.0, available at -https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. - -Community Impact Guidelines were inspired by [Mozilla's code of conduct -enforcement ladder](https://github.com/mozilla/diversity). - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see the FAQ at -https://www.contributor-covenant.org/faq. Translations are available at -https://www.contributor-covenant.org/translations. - diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md deleted file mode 100644 index 16b00b0a..00000000 --- a/docs/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,123 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -We as members, contributors, and leaders pledge to make participation in our -community a harassment-free experience for everyone. - -We pledge to act and interact in ways that contribute to an open, welcoming, -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 e-mail 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 by emailing the -ASF APD/Tools team at [UAF-asf-apd@alaska.edu](mailto:UAF-asf-apd@alaska.edu). -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 - -Community leaders will follow these Community Impact Guidelines in determining -the consequences for any action they deem in violation of this Code of Conduct: - -### 1. Correction - -**Community Impact**: Use of inappropriate language or other behavior deemed -unprofessional or unwelcome in the community. - -**Consequence**: A private, written warning from community leaders, providing -clarity around the nature of the violation and an explanation of why the -behavior was inappropriate. A public apology may be requested. - -### 2. Warning - -**Community Impact**: A violation through a single incident or series -of actions. - -**Consequence**: A warning with consequences for continued behavior. No -interaction with the people involved, including unsolicited interaction with -those enforcing the Code of Conduct, for a specified period of time. This -includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or -permanent ban. - -### 3. Temporary Ban - -**Community Impact**: A serious violation of community standards, including -sustained inappropriate behavior. - -**Consequence**: A temporary ban from any sort of interaction or public -communication with the community for a specified period of time. No public or -private interaction with the people involved, including unsolicited interaction -with those enforcing the Code of Conduct, is allowed during this period. -Violating these terms may lead to a permanent ban. - -### 4. Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an -individual, or aggression toward or disparagement of classes of individuals. - -**Consequence**: A permanent ban from any sort of public interaction within -the community. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org "https://www.contributor-covenant.org" ){target=_blank}, -version 2.0, available at -{target=_blank}. - -Community Impact Guidelines were inspired by [Mozilla's code of conduct -enforcement ladder](https://github.com/mozilla/diversity "https://github.com/mozilla/diversity" ){target=_blank}. - -For answers to common questions about this code of conduct, see the FAQ at -{target=_blank}. Translations are available at -{target=_blank}. - diff --git a/docs/contributing.md b/docs/contributing.md index be23799d..f31a8870 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -6,7 +6,7 @@ We're excited you would like to contribute to HyP3! Whether you're finding bugs, adding new features, fixing anything broken, or improving documentation, get started by submitting an issue or pull request! -Please read our [Code of Conduct](CODE_OF_CONDUCT.md "HyP3 Code of Conduct" ){target=_blank} before contributing. +Please read our [Code of Conduct](https://github.com/ASFHyP3/.github/blob/main/CODE_OF_CONDUCT.md "HyP3 Code of Conduct" ){target=_blank} before contributing. ## Issues and Pull Requests are welcome diff --git a/environment.yml b/environment.yml index b6928c12..e887a0f2 100644 --- a/environment.yml +++ b/environment.yml @@ -5,17 +5,7 @@ channels: dependencies: - 'python=3.10' - pip - # For documentation - - mkdocs=1.5.3 - - mkdocs-material=9.4.2 - hyp3_sdk=7.0.3 # also pinned in docs/using/sdk.md - asf_tools=0.8.3 # also pinned in docs/tools/asf_tools.md - - requests - pip: - # For documentation - - mkdocs-asf-theme==0.3.2 - - mkdocs-redirects - - mkdocs-section-index - - mkdocstrings - - mkdocstrings-python - - mkdocs-macros-plugin + - -r requirements.txt diff --git a/mkdocs.yml b/mkdocs.yml index c941e710..daed866b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -100,7 +100,7 @@ nav: - Architecture: how_it_works.md - Plugins: plugins.md - Contributing: contributing.md - - Code of Conduct: CODE_OF_CONDUCT.md + - Code of Conduct: https://github.com/ASFHyP3/.github/blob/main/CODE_OF_CONDUCT.md" target="_blank - What's New: whats_new.md - Contact Us: contact.md diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..248dee00 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,9 @@ +mkdocs==1.5.3 +mkdocs-material==9.4.2 +mkdocs-asf-theme==0.3.2 +mkdocs-redirects +mkdocs-section-index +mkdocstrings==0.27.0 # FIXME: https://github.com/ASFHyP3/hyp3-docs/issues/498 +mkdocstrings-python +mkdocs-macros-plugin +requests