Skip to content

Commit

Permalink
hook-fix: Apply automatic fixes made by workflow hooks
Browse files Browse the repository at this point in the history
  • Loading branch information
AAriam authored and RepoDynamicsBot committed Nov 29, 2023
1 parent 7a096a2 commit 87bdc9a
Show file tree
Hide file tree
Showing 14 changed files with 28 additions and 29 deletions.
28 changes: 14 additions & 14 deletions .meta/core/intro.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,19 +54,19 @@ keynotes:
${{ name }} fully automates your entire software development process from start to finish,
using a complete set of fully-configured GitHub Actions workflows,
professionally designed and implemented according to the latest standards and best practices.
The following is a simplified example of one of ${{ name }}'s main workflows:
Every time a new issue is opened in your repository, ${{ name }} automatically
processes the issue and reformats the text into a pre-defined style,
to ensure consistency and readability across all issues in your repository.
to ensure consistency and readability across all issues in your repository.
It also adds a comment to the issue, which tracks its status,
and is automatically updated whenever there is a progress.
Moreover, based on the contents of the issue, it is automatically assigned to a defined maintainer,
and tagged with various labels that indicate the type and status of the issue,
along with its target branches and package versions.
The assigned maintainer can then triage the issue and change its status label accordingly.
For example, if the issue is labeled as accepted,
${{ name }} automatically creates a new development branch from each of the issue's target branches,
and transforms the issue into draft pull requests for each of the development branches.
Expand All @@ -77,7 +77,7 @@ keynotes:
Furthermore, depending on the type of changes,
${{ name }} automatically publishes developmental versions of your package on TestPyPI,
and generates previews of your documentation website throughout the development process.
Finally, when a development branch is marked as complete, ${{ name }} automatically
removes the draft status from the corresponding pull request,
adds a summary of all applied changes, and requests reviews from the assigned maintainers.
Expand Down Expand Up @@ -107,7 +107,7 @@ keynotes:
using a single, unified, and consistent interface;
${{ name }} automatically translates your changes into the appropriate formats,
generates all necessary files in the required locations, and updates them dynamically.
The control center contains all key information and metadata of your project,
such as its name, description, keywords, license and copyright information,
authors/maintainers and their roles, contact information, citations,
Expand All @@ -118,7 +118,7 @@ keynotes:
the project's owner, authors, maintainers, and contributors, are periodically retrieved
from GitHub, and a full list of your package's active releases and their corresponding
information are generated and maintained automatically.
Furthermore, the control center contains all configurations and metadata for your
GitHub/Git repository (e.g. general settings; branch protection rules; security configurations;
GitHub Pages settings; templates for issues, pull requests, and discussions; funding options;
Expand All @@ -132,7 +132,7 @@ keynotes:
(e.g. settings for various linting, formatting, and testing tools such as
Ruff, Mypy, Pylint, Bandit, Isort, Black, Pytest, Pytest-cov, etc.;
pre-commit hooks configurations; settings for external platforms such as Codecov and ReadTheDocs).
In addition, to eliminate any redundancy and provide your project with a high degree of flexibility
and customization, ${{ name }} allows for complex and recursive templating within all contents of
the control center, meaning that you can reference and reuse any piece of configuration or data
Expand All @@ -147,7 +147,7 @@ keynotes:
${{ name }} allows you to make most parts of your repository's contents and interfaces dynamic.
In addition to all the configuration and metadata files described above,
the following are a few examples of how this feature is further utilized:
Issue and discussion forms of your repository (defined in the control center) are completely dynamic.
For example, they contain dropdown menus for the user to select the package version, Python version,
operating system, and other specifications relevant to the issue.
Expand All @@ -157,15 +157,15 @@ keynotes:
${{ name }} uses its templating mechanism to dynamically reference the corresponding specifications.
Since these are automatically updated whenever there is a change, this ensures that the forms
are always up to date, without the need for any manual intervention on your part.
Similarly, changelogs and release notes, which are automatically generated and updated according
to the templates defined in the control center, also use a variety of dynamic references,
such as package version, release date, commit hash, link to the corresponding pull request,
dependency and requirement changes, list of contributors, and of course, the details of applied changes.
These are all dynamically obtained from various contexts, so that complete changelog entries and
release notes can be automatically generated and added to your repository and website
upon merging a pull request into a release branch.
upon merging a pull request into a release branch.
Furthermore, all community health files (e.g. contribution guidelines, code of conduct,
support guidelines, security policy, etc.), license files, and directory README files are also
dynamically generated and updated according to the templates defined in the control center.
Expand All @@ -175,7 +175,7 @@ keynotes:
Therefore, instead of requiring you to manually scan multiple files and update
the corresponding information whenever there is a change,
${{ name }} automatically updates all relevant files whenever any of the referenced information changes.
In addition, the entire content defined in your control center is also made available
to your documentation website, allowing you to dynamically reference any piece of information,
configuration, or metadata of your project in your website's content.
Expand All @@ -195,7 +195,7 @@ keynotes:
description: |
While carefully configured, ${{ name }} is also fully customizable,
allowing you to tailor every aspect of your development pipeline to your specific needs.
${{ name }} also allows you to extend your project's configuration and metadata with
your own custom specifications, which can then be referenced and utilized anywhere in
your project, the same way as the built-in contents of the control center.
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The following is a simplified example of one of PyPackIT's main workflows:

Every time a new issue is opened in your repository, PyPackIT automatically
processes the issue and reformats the text into a pre-defined style,
to ensure consistency and readability across all issues in your repository.
to ensure consistency and readability across all issues in your repository.
It also adds a comment to the issue, which tracks its status,
and is automatically updated whenever there is a progress.
Moreover, based on the contents of the issue, it is automatically assigned to a defined maintainer,
Expand Down Expand Up @@ -168,7 +168,7 @@ such as package version, release date, commit hash, link to the corresponding pu
dependency and requirement changes, list of contributors, and of course, the details of applied changes.
These are all dynamically obtained from various contexts, so that complete changelog entries and
release notes can be automatically generated and added to your repository and website
upon merging a pull request into a release branch.
upon merging a pull request into a release branch.

Furthermore, all community health files (e.g. contribution guidelines, code of conduct,
support guidelines, security policy, etc.), license files, and directory README files are also
Expand All @@ -179,7 +179,7 @@ list of maintainers, links to additional information on your website, and so on.
Therefore, instead of requiring you to manually scan multiple files and update
the corresponding information whenever there is a change,
PyPackIT automatically updates all relevant files whenever any of the referenced information changes.

In addition, the entire content defined in your control center is also made available
to your documentation website, allowing you to dynamically reference any piece of information,
configuration, or metadata of your project in your website's content.
Expand Down
2 changes: 1 addition & 1 deletion docs/website/source/intro/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ A summary of key concepts and related background information,
essential to fully understanding and utilizing {{pp_meta.name}}.
:::

::::
::::
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Automatic Fixes
# Automatic Fixes
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Synchronization
# Synchronization
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Comment
# Comment
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Dispatch
# Dispatch
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Issue
# Issue
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Pull Request
# Pull Request
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ The [`push`](https://docs.github.com/en/actions/using-workflows/events-that-trig
is triggered when a commit or tag is pushed to a branch in the remote repository.
It is also triggered when branches are created or deleted,
or when the repository is created for the first time.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Issue
# Issue
2 changes: 1 addition & 1 deletion docs/website/source/manual/usage/package/index.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Package
# Package
2 changes: 1 addition & 1 deletion docs/website/source/manual/usage/tests/index.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Test Suite
# Test Suite
2 changes: 1 addition & 1 deletion docs/website/source/manual/usage/website/index.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Website
# Website

0 comments on commit 87bdc9a

Please sign in to comment.