Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions .cruft.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"template": "/home/raknop/roman/package-template",
"commit": "8dd697cb99ede8451cdf622ecd00923c1786fd28",
"checkout": "u/rknop/docs",
"context": {
"cookiecutter": {
"package_name": "phrosty",
"module_name": "phrosty",
"github_snpit_repo_name": "phrosty",
"short_description": "Difference imaging forced photometry pipeline",
"author_name": "Lauren Aldoroty",
"author_email": "[email protected]",
"github_username": "laldoroty",
"minimum_python_version": "3.11",
"use_compiled_extensions": "n",
"include_example_code": "n",
"include_github_workflows": "y",
"_project_url": "https://github.com/Roman-Supernova-PIT",
"_pit_github_org": "Roman-Supernova-PIT",
"_pit_name": "Roman Supernove Project Infrastructure Team",
"_sphinx_theme": "alabaster",
"_parent_project": "",
"install_requires": "",
"_copy_without_render": [
"docs/_templates",
"docs/_static",
".github/workflows",
".github/"
],
"_template": "/home/raknop/roman/package-template",
"_commit": "8dd697cb99ede8451cdf622ecd00923c1786fd28"
}
},
"directory": null
}
9 changes: 9 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# automatically requests pull request reviews for files matching the given pattern; the last match takes precendence. Make sure the software-admin team has write on your repo

* @laldoroty @Roman-Supernova-Pit/software-admins
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is "unknown owner" a problem here? do I need to be added to software-admins?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly, I'm not sure what the story is here... we shouldn't add everybody who is the owner of a package to the software-admins group. I'll have to talk to Megan about this, but for now, let's ignore the bug.


# maintainers, add specifics of what you want to maintain for your package
# the software-admins should remain owners of everything as above

/docs/** @laldoroty
/changes/** @laldoroty
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: "Feature request"
about: Suggest an idea for this project
title: "[New Feature]: "
labels: enhancement, needs triage
assignees: ''
---

## Is your feature request related to a problem? Please describe.
<!--A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...] -->

## Describe the solution you'd like
<!--A clear and concise description of what you want to happen.-->

## Describe alternatives you've considered
<!--A clear and concise description of any alternative solutions or features you've considered.-->

## Additional context
<!--Add any other context or screenshots about the feature request here.-->

47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
name: "🐞 Issue report for phrosty"
about: Create a report describing unexpected or incorrect behavior.
title: "[Issue]: <title>"
labels: bug
assignees: ''
---

<!--
Thanks for taking the time to fill out this report!
Please have a search on our repository to see if a similar
issue has already been posted. If a similar issue is closed, have a
quick look to see if you are satisfied by the resolution.

If not please go ahead and open an issue!
-->

### Current Behavior:
<!-- A concise description of what you're experiencing. -->

### Expected Behavior:
<!-- A concise description of what you expected to happen. -->

### Steps To Reproduce:
<!--
Example: steps to reproduce the behavior:
1. In this environment...
1. With this config...
1. Run '...'
1. See error...
-->

### Environment:
<!--
Example:
- OS: Ubuntu 20.04
- Node: 13.14.0
- npm: 7.6.3
- python: 3.13
- numpy: 2.0
-->

### Anything else:
<!--
Links? References? Anything that will give us more context about the issue that you are encountering!
-->

39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/PR_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: "Pull Request for phrosty"
about: Create a pull request to submit new or updated code to the repository
title: "[PR]: "
labels: possible solution
assignees: ''
---
## What type of PR is this? (check all applicable)

- [ ] Refactor
- [ ] Feature
- [ ] Bug Fix
- [ ] Optimization
- [ ] Documentation Update
- [ ] Have you followed the guidelines in our Contributing document?
- [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change?

<!-- describe the changes included with this PR here -->
This PR addresses ...

<!-- If this PR closes a GitHub issue, reference it here by its number -->
Closes #


<!-- if you can't perform these tasks due to permissions, please ask a maintainer to do them -->
## Tasks
- [ ] **request a review from someone specific**, to avoid making the maintainers review every PR
- [ ] Does this PR change user-facing code / API? (if not, label with `no-changelog-entry-needed`)
- [ ] write news fragment(s) in `changes/`: `echo "changed something" > changes/<PR#>.<changetype>.rst` (see expansion below for change types)
- [ ] update or add relevant tests
- [ ] update relevant docstrings and / or `docs/` page
- [ ] Do truth files need to be updated?


<details><summary>news fragment change types...</summary>

- ``changes/<PR#>.general.rst``: infrastructure or miscellaneous change
- ``changes/<PR#>.docs.rst``: updates for documentation
</details>
38 changes: 38 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: "Dependabot Checks"
version: 2
updates:

# maintain dependencies for pip
# this should help with pyproject.toml
- package-ecosystem: pip
directory: "/"
target-branch: "main"
schedule:
interval: weekly
open-pull-requests-limit: 10
reviewers:
- "laldoroty"
allow:
- dependency-type: direct
- dependency-type: indirect
commit-message:
prefix: "fix: "
labels:
- "CI/CD"

# maintain dependencies for github-actions
- package-ecosystem: "github-actions"
directory: ".github/workflows"
target-branch: "main"
reviewers:
- "laldoroty"
schedule:
interval: monthly
commit-message:
prefix: "fix: "
labels:
- "CI/CD"
groups:
actions:
patterns:
- "*"
34 changes: 34 additions & 0 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# needs pull_request_target to label forks
documentation:
- changed-files:
- all-globs-to-any-file: ['*.rst', '!CHANGES.rst', '!licenses/LICENSE']
- any-glob-to-any-file:
- 'docs/**/*'
- '*.md'
- '.readthedocs.yaml'
- 'CITATION.cff'

installation:
- changed-files:
- any-glob-to-any-file:
- 'pyproject.toml'
- 'setup.*'
- 'requirements*.txt'
- 'MANIFEST.in'

# --------------------------------------- testing ---------------------------------------

automation:
- changed-files:
- any-glob-to-any-file:
- '.github/**'
- '.bandit.yaml'
- '.codecov.yml'

testing:
- changed-files:
- any-glob-to-any-file:
- '**/tests/**'
- '.github/workflows/*ci*.yml'
- 'conftest.py'
- 'tox.ini'
37 changes: 37 additions & 0 deletions .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: changelog

on:
pull_request:
types:
- labeled
- unlabeled
- opened
- synchronize
- reopened

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
with:
python-version: 3
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0
- run: pip install .
- run: pip install towncrier
- run: towncrier check
- run: towncrier build --draft | grep -P '#${{ github.event.number }}'
prevent_manually_editing_changlog:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0
- name: prevent direct changes to `CHANGES.rst`
run: git diff HEAD ${{ github.event.pull_request.base.sha }} --no-patch --exit-code CHANGES.rst
21 changes: 21 additions & 0 deletions .github/workflows/run_labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Label pull request

on:
pull_request_target:
types:
- opened
- synchronized
- reopened

jobs:
labeler:
permissions:
contents: read
pull-requests: write
runs-on: ubuntu-latest
steps:
- uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9 # v5.0.0
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
sync-labels: true # removes labels when files reverted
configuration-path: .github/labeler.yml
27 changes: 27 additions & 0 deletions .github/workflows/sphinx-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: "Deploy Package Documentation to Pages"

on:
push:
branches: [main] # branch to trigger deployment

workflow_dispatch:

jobs:
pages:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- id: deployment
uses: sphinx-notes/pages@23ef64097ef9b00d8f71e978bc518ee32ca98651 # v3.2
with:
publish: false
documentation_path: ./docs
pyproject_extras: docs
- uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ${{ steps.deployment.outputs.artifact }}
publish_branch: gh-pages # default: gh-pages
commit_message: ${{ github.event.head_commit.message }}

Loading
Loading