diff --git a/.github/github-repo-workflow.json b/.github/github-repo-workflow.json new file mode 100644 index 0000000..3a10277 --- /dev/null +++ b/.github/github-repo-workflow.json @@ -0,0 +1,16 @@ +{ + "defaultBranch": "main", + "importantWorkflows": ["CI", "Publish"], + "qaLabels": [], + "deployLabels": [], + "healthUrls": [ + { + "name": "PyPI", + "url": "https://pypi.org/project/printnode-community/" + } + ], + "cleanup": { + "deleteMergedLocalBranches": true, + "removeMergedCleanWorktrees": true + } +} diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..30cf57e --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,10 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ +# Ignored default folder with query files +/queries/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml new file mode 100644 index 0000000..0aa18bd --- /dev/null +++ b/.idea/inspectionProfiles/Project_Default.xml @@ -0,0 +1,67 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml new file mode 100644 index 0000000..105ce2d --- /dev/null +++ b/.idea/inspectionProfiles/profiles_settings.xml @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..4eee98c --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/.idea/printnode_community.iml b/.idea/printnode_community.iml new file mode 100644 index 0000000..6a0e387 --- /dev/null +++ b/.idea/printnode_community.iml @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..3802e85 --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,16 @@ + + + + + + + + + \ No newline at end of file diff --git a/AGENTS.md b/AGENTS.md index c78c4f9..018cb6d 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -7,6 +7,8 @@ This repository is maintained as a careful, community-oriented Python client for ## Branch and PR Rules - The default branch is `main`. +- Keep repo workflow defaults in `.github/github-repo-workflow.json` so future + GitHub workflow sessions can discover important workflows and cleanup policy. - Do not commit directly to `main`. - Use a focused branch and pull request for every meaningful change. - Keep pull requests small enough to review. diff --git a/CHANGELOG.md b/CHANGELOG.md index cac9d06..ba62375 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,8 @@ The format follows the spirit of Keep a Changelog, and this project intends to u ## Unreleased -- Nothing yet. +- Added repository workflow defaults for future GitHub workflow sessions. +- Updated post-release documentation now that `0.3.0` is published. ## 0.3.0 - 2026-04-26 diff --git a/README.md b/README.md index 2e064a3..b6824ff 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ This is a Python library to interact with PrintNode's remote printing API. This ### Installation -After the first maintained release is published, install the package with: +Install the maintained community package with: ```sh uv add printnode_community @@ -37,8 +37,6 @@ For editable development installs, use: uv pip install -e . ``` -Until the first maintained release is published, prefer installing from a reviewed Git tag or branch rather than relying on an unpublished local build. - ### Development Install development dependencies and run tests with: @@ -57,7 +55,9 @@ uv run twine check dist/* ### Releases -Release publishing is not enabled for general use yet. See [RELEASE.md](RELEASE.md) for the release process and TestPyPI/PyPI workflow requirements. +Maintained releases are published to PyPI from reviewed release tags. See +[RELEASE.md](RELEASE.md) for the release process and TestPyPI/PyPI workflow +requirements. ### Getting Started diff --git a/SECURITY.md b/SECURITY.md index a891de8..15f6ed4 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,9 +2,9 @@ ## Supported Versions -This fork is being prepared for a maintained release. Until the first maintained release is published, security fixes target the current `main` branch. - -After the first release, supported versions will be documented here and in the release notes. +Security fixes target the current `main` branch and maintained PyPI releases. +Supported versions are documented here and in release notes as the project +matures. ## Reporting a Vulnerability