-
Notifications
You must be signed in to change notification settings - Fork 2
Moving phrosty over to the package template #66
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
55267cf
Moving phrosty over to the package template
rknop 1a6c4f7
changelog
rknop 945d051
In the middle of adapting tests and things after package template
rknop fd8ac7b
Some testing code
rknop eb4a449
get rid of README.md, put its stuff in README.rst and edit
rknop 6b224b2
more README edit
rknop f5add43
readme
rknop 0b97bfe
RST!!!!!!!!!!!!!!!!!111
rknop 45eacec
edit readme and citation
rknop 4179683
readme
rknop File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
|
|
||
| # 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 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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.--> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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! | ||
| --> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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: | ||
| - "*" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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' |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 }} | ||
|
|
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.