Skip to content

Commit

Permalink
Add list of projects using xCDAT (#617)
Browse files Browse the repository at this point in the history
- Update GitHub issue templates to use latest tags
- Update release drafter labels
  • Loading branch information
tomvothecoder authored Mar 15, 2024
1 parent 38cdfd5 commit f120c2d
Show file tree
Hide file tree
Showing 6 changed files with 51 additions and 38 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Bug Report
description: File a bug report to help us improve xCDAT
title: "[Bug]: "
labels: ["Type: Bug"]
labels: ["type: bug"]
assignees: []
body:
- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Documentation Update
description: Update xCDAT documentation
title: "[Doc]: "
labels: ["Type: Documentation"]
labels: ["type: docs"]
assignees: []
body:
- type: textarea
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Feature Request
description: Suggest an idea for xCDAT
title: "[Feature]: "
labels: ["Type: Enhancement"]
name: Enhancement Request
description: Suggest an enhancement for xCDAT
title: "[Enhancement]: "
labels: ["type: enhancement"]
assignees: []
body:
- type: textarea
Expand All @@ -21,7 +21,7 @@ body:
description: |
A clear and concise description of what you want to happen.
validations:
required: false
required: false

- type: textarea
id: alternatives
Expand Down
18 changes: 9 additions & 9 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
name-template: "v$RESOLVED_VERSION"
tag-template: "v$RESOLVED_VERSION"
autolabeler:
- label: "Type: Enhancement"
- label: "type: enhancement"
branch: '/feature\/.+/'
- label: "Type: Bug"
- label: "type: bug"
branch: '/(bug)?fix\/.+/'
title: "/fix/i"
- label: "Type: Documentation"
- label: "type: docs"
files: "*.rst"
branch: '/docs{0,1}\/.+/'
- label: "Type: DevOps"
- label: "type: devops"
branch: '/devops\/.+/'
categories:
- title: "Features"
labels: "Type: Enhancement"
- title: "Enhancements"
labels: "type: enhancement"
- title: "Bug Fixes"
labels: "Type: Bug"
labels: "type: bug"
- title: "Documentation"
label: "Type: Documentation"
label: "type: docs"
- title: "DevOps"
label: "Type: DevOps"
label: "type: devops"
change-template: "- $TITLE by @$AUTHOR in $URL"
change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
exclude-labels:
Expand Down
44 changes: 22 additions & 22 deletions .github/workflows/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
name: Release Drafter

on:
push:
# branches to consider in the event; optional, defaults to all
branches:
- main
# pull_request event is required only for autolabeler
pull_request:
# Only following types are handled by the action, but one can default to all as well
types: [opened, reopened, synchronize]
push:
# branches to consider in the event; optional, defaults to all
branches:
- main
# pull_request event is required only for autolabeler
pull_request:
# Only following types are handled by the action, but one can default to all as well
types: [opened, reopened, synchronize]

permissions:
contents: read
contents: read

jobs:
update_release_draft:
permissions:
# write permission is required to create a github release
contents: write
# write permission is required for autolabeler
# otherwise, read permission is required at least
pull-requests: write
runs-on: ubuntu-latest
steps:
# Drafts your next Release notes as Pull Requests are merged into "main"
- uses: release-drafter/release-drafter@v5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
update_release_draft:
permissions:
# write permission is required to create a github release
contents: write
# write permission is required for autolabeler
# otherwise, read permission is required at least
pull-requests: write
runs-on: ubuntu-latest
steps:
# Drafts your next Release notes as Pull Requests are merged into "main"
- uses: release-drafter/release-drafter@v6
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
13 changes: 13 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,19 @@ Environmental Research (`BER`_) within the `Department of Energy`_'s `Office of
.. _Department of Energy: https://www.energy.gov/
.. _Office of Science: https://science.osti.gov/

Projects Using xCDAT
--------------------

xCDAT is actively being integrated as a core component of the `Program for Climate Model
Diagnosis and Intercomparison (PCMDI) Metrics Package`_ and the `Energy Exascale Earth
System Model Diagnostics (E3SM) Package`_. xCDAT is also included in the `E3SM Unified
Anaconda Environment`_ that is deployed on various U.S. Department of Energy
supercomputers to run E3SM software tools.

.. _Program for Climate Model Diagnosis and Intercomparison (PCMDI) Metrics Package: https://pcmdi.github.io/pcmdi_metrics/
.. _Energy Exascale Earth System Model Diagnostics (E3SM) Package: https://e3sm-project.github.io/e3sm_diags/_build/html/main/index.html
.. _E3SM Unified Anaconda Environment: https://e3sm.org/resources/tools/other-tools/e3sm-unified-environment/

License
-------

Expand Down

0 comments on commit f120c2d

Please sign in to comment.