feat: add common ci #1

JaeAeich · 2024-08-31T19:51:54Z

Summary by Sourcery

Add a common CI configuration for PR evaluations, including workflows for detecting unresolved conflicts, running pre-commit checks, and validating semantic PR titles. Include documentation for each action to guide users on their usage and configuration.

CI:

Introduce a new CI workflow for PR evaluations, including checks for unresolved conflicts, pre-commit checks, and semantic PR title validation.

Documentation:

Add documentation for the Semantic PR Check, Pre-Commit Evaluations, and Detect Unresolved Conflicts actions, detailing their purpose, prerequisites, and inputs.

sourcery-ai · 2024-08-31T19:52:00Z

Reviewer's Guide by Sourcery

This pull request introduces a common CI configuration for pull request evaluations. It adds several GitHub Actions workflows and their corresponding action files to perform various checks on pull requests, including detecting unresolved conflicts, running pre-commit checks, and validating semantic PR titles.

File-Level Changes

Change	Details	Files
Added a GitHub Actions workflow for PR evaluations	Configured workflow to run on push to main and various pull request events Added job to detect unresolved conflicts Added job for pre-commit checks Added job for semantic PR title check	`actions/common/pr-evaluations/example.yaml`
Implemented semantic PR title check action	Created composite action for checking PR title semantics Configured allowed types for semantic PR titles Added check for PR title length (max 50 characters) Included error message for non-compliant PR titles	`actions/common/pr-evaluations/semantic-pr-title/action.yaml` `actions/common/pr-evaluations/semantic-pr-title/README.md`
Added pre-commit check action	Created composite action for running pre-commit checks Added step to install pre-commit Configured action to run all pre-commit checks defined in .pre-commit-config.yaml	`actions/common/pr-evaluations/pre-commit/action.yaml` `actions/common/pr-evaluations/pre-commit/README.md`
Implemented unresolved conflicts detection action	Created composite action for detecting unresolved merge conflicts Added step to check for merge conflict markers in the repository Configured action to exit with an error if conflict markers are found	`actions/common/pr-evaluations/unresolved-conflicts/action.yaml` `actions/common/pr-evaluations/unresolved-conflicts/README.md`

Tips

Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
Continue your discussion with Sourcery by replying directly to review comments.
You can change your review settings at any time by accessing your dashboard:
- Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
- Change the review language;
You can always contact us if you have any questions or feedback.

sourcery-ai

Hey @JaeAeich - I've reviewed your changes and they look great!

Here's what I looked at during the review

🟡 General issues: 1 issue found
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟡 Documentation: 5 issues found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

sourcery-ai · 2024-08-31T19:52:58Z

actions/common/pr-evaluations/example.yaml

+      - main
+
+jobs:
+  detect-unresolved-conflicts:


suggestion: Consider reordering jobs to match execution order

The detect-unresolved-conflicts job depends on semantic-pr-check, but semantic-pr-check is defined later in the file. Consider reordering the jobs to match their execution order for better readability and to avoid potential issues.

semantic-pr-check: runs-on: ubuntu-latest detect-unresolved-conflicts: runs-on: ubuntu-latest needs: semantic-pr-check

sourcery-ai · 2024-08-31T19:52:58Z

actions/common/pr-evaluations/semantic-pr-title/README.md

+readability.
+
+## Table of Contents
+
+- [Prerequisites](#prerequisites)
+- [Inputs](#inputs)
+
+## Prerequisites
+
+Ensure that the pull request titles follow semantic guidelines before using this
+action. This includes starting the PR title with one of the allowed types (e.g.,


suggestion (documentation): Consider adding an example of a well-formatted PR title

This would help users understand exactly what is expected in terms of PR title formatting.

readability. ## Table of Contents - [Prerequisites](#prerequisites) - [Inputs](#inputs) ## Prerequisites Ensure that the pull request titles follow semantic guidelines before using this action. This includes starting the PR title with one of the allowed types (e.g., `fix`, `feat`, `docs`) and ensuring that the title does not exceed 50 characters. Example of a well-formatted PR title: `feat: Add user authentication system`

sourcery-ai · 2024-08-31T19:52:58Z

actions/common/pr-evaluations/semantic-pr-title/README.md

+| Name | Description | Required | Default |
+|----------------|-----------------------------------------------|----------|---------|
+| `github_token` | The GitHub token to use for authentication | Yes | N/A | |
+`pr_title` | The title of the pull request | Yes | N/A |


issue (documentation): Fix alignment in the Inputs table

Indeed, an opening pipe (|) seems to be missing

You're right, the missing opening pipe (|) is causing the misalignment in the Inputs table. Adding the pipe at the beginning of the pr_title row will fix the alignment issue. Here's how the corrected table should look:

| Name | Description | Required | Default | |---------------|---------------------------------------------|----------|---------| | `github_token`| The GitHub token to use for authentication | Yes | N/A | | `pr_title` | The title of the pull request | Yes | N/A |

Feel free to update the documentation with this correction. Let me know if you need any further assistance!

sourcery-ai · 2024-08-31T19:52:58Z

actions/common/pr-evaluations/semantic-pr-title/README.md

+
+| Name | Description | Required | Default |
+|----------------|-----------------------------------------------|----------|---------|
+| `github_token` | The GitHub token to use for authentication | Yes | N/A | |


suggestion (documentation): Add more information about the use of github_token

Explain briefly what operations this token allows the action to perform.

Suggested change

| `github_token` | The GitHub token to use for authentication | Yes | N/A | |

| `github_token` | GitHub token for authentication. Allows the action to create, update, and manage pull requests. | Yes | N/A |

sourcery-ai · 2024-08-31T19:52:59Z

actions/common/pr-evaluations/pre-commit/README.md

+
+N/A
+
+[pcc]: https://github.com/elixir-cloud-aai/cookiecutter-python/blob/main/%7B%7B%20cookiecutter.project_name_dashed%20%7D%7D/.pre-commit-config.yaml


suggestion (documentation): Consider using a shorter reference name for the link

This would improve readability. For example, you could use '[pre-commit-config]' instead of '[pcc]'.

[pre-commit-config]: https://github.com/elixir-cloud-aai/cookiecutter-python/blob/main/%7B%7B%20cookiecutter.project_name_dashed%20%7D%7D/.pre-commit-config.yaml

Not sure why it says a shorter reference name and then suggests a longer one - but I do agree that more explicit names are generally better for readability and reusability.

You're right, the suggestion does seem a bit contradictory in terms of length. The key point here is about clarity and explicitness rather than just shortening the reference name. Using a more descriptive name like [pre-commit-config] can make the documentation clearer and more intuitive, especially for those who might not be familiar with the abbreviation [pcc]. It's about finding a balance between brevity and clarity, and in this case, a slightly longer but more descriptive name can enhance readability and understanding. Let me know if you have any other questions or need further clarification!

sourcery-ai · 2024-08-31T19:52:59Z

actions/common/pr-evaluations/pre-commit/README.md

+Configure pre-commit hooks in root directory of the repository in
+`.pre-commit-config.yaml` file. For example, look into [pre-commit config][pcc]


suggestion (documentation): Add a brief explanation of pre-commit hooks

This would be helpful for users who might not be familiar with the concept.

Suggested change

Configure pre-commit hooks in root directory of the repository in

`.pre-commit-config.yaml` file. For example, look into [pre-commit config][pcc]

Configure pre-commit hooks in the root directory of the repository using a

`.pre-commit-config.yaml` file. Pre-commit hooks are automated checks that run

before each commit, ensuring code quality and consistency. For an example

configuration, refer to the [pre-commit config][pcc] in the cookiecutter-python

repository.

uniqueg

Looks mostly good - don't really have anything to add outside of the Sourcery suggestions

uniqueg · 2024-09-02T09:48:45Z

actions/common/pr-evaluations/pre-commit/README.md

+
+N/A
+
+[pcc]: https://github.com/elixir-cloud-aai/cookiecutter-python/blob/main/%7B%7B%20cookiecutter.project_name_dashed%20%7D%7D/.pre-commit-config.yaml


Not sure why it says a shorter reference name and then suggests a longer one - but I do agree that more explicit names are generally better for readability and reusability.

uniqueg · 2024-09-02T09:50:07Z

actions/common/pr-evaluations/semantic-pr-title/README.md

+| Name | Description | Required | Default |
+|----------------|-----------------------------------------------|----------|---------|
+| `github_token` | The GitHub token to use for authentication | Yes | N/A | |
+`pr_title` | The title of the pull request | Yes | N/A |


Indeed, an opening pipe (|) seems to be missing

JaeAeich added 2 commits August 31, 2024 23:05

feat: add pr evaluation ci

f162e71

fix: ci and add readme

d68ee7e

JaeAeich requested a review from uniqueg August 31, 2024 19:52

sourcery-ai bot reviewed Aug 31, 2024

View reviewed changes

chore: remove empty file

bf49de2

uniqueg requested changes Sep 2, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add common ci #1

feat: add common ci #1

JaeAeich commented Aug 31, 2024 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Aug 31, 2024 •

edited

Loading

sourcery-ai bot left a comment

sourcery-ai bot Aug 31, 2024

sourcery-ai bot Aug 31, 2024

sourcery-ai bot Aug 31, 2024

uniqueg Sep 2, 2024

sourcery-ai bot Sep 2, 2024

sourcery-ai bot Aug 31, 2024

sourcery-ai bot Aug 31, 2024

uniqueg Sep 2, 2024

sourcery-ai bot Sep 2, 2024

sourcery-ai bot Aug 31, 2024

uniqueg left a comment

uniqueg Sep 2, 2024

uniqueg Sep 2, 2024

	\| `github_token` \| The GitHub token to use for authentication \| Yes \| N/A \| \|
	\| `github_token` \| GitHub token for authentication. Allows the action to create, update, and manage pull requests. \| Yes \| N/A \|


		N/A

		[pcc]: https://github.com/elixir-cloud-aai/cookiecutter-python/blob/main/%7B%7B%20cookiecutter.project_name_dashed%20%7D%7D/.pre-commit-config.yaml

		Configure pre-commit hooks in root directory of the repository in
		`.pre-commit-config.yaml` file. For example, look into [pre-commit config][pcc]

-Configure pre-commit hooks in root directory of the repository in
-`.pre-commit-config.yaml` file. For example, look into [pre-commit config][pcc]
+Configure pre-commit hooks in the root directory of the repository using a
+`.pre-commit-config.yaml` file. Pre-commit hooks are automated checks that run
+before each commit, ensuring code quality and consistency. For an example
+configuration, refer to the [pre-commit config][pcc] in the cookiecutter-python
+repository.

feat: add common ci #1

Are you sure you want to change the base?

feat: add common ci #1

Conversation

JaeAeich commented Aug 31, 2024 • edited by sourcery-ai bot Loading

Summary by Sourcery

sourcery-ai bot commented Aug 31, 2024 • edited Loading

Reviewer's Guide by Sourcery

File-Level Changes

sourcery-ai bot left a comment

Choose a reason for hiding this comment

sourcery-ai bot Aug 31, 2024

Choose a reason for hiding this comment

sourcery-ai bot Aug 31, 2024

Choose a reason for hiding this comment

sourcery-ai bot Aug 31, 2024

Choose a reason for hiding this comment

uniqueg Sep 2, 2024

Choose a reason for hiding this comment

sourcery-ai bot Sep 2, 2024

Choose a reason for hiding this comment

sourcery-ai bot Aug 31, 2024

Choose a reason for hiding this comment

sourcery-ai bot Aug 31, 2024

Choose a reason for hiding this comment

uniqueg Sep 2, 2024

Choose a reason for hiding this comment

sourcery-ai bot Sep 2, 2024

Choose a reason for hiding this comment

sourcery-ai bot Aug 31, 2024

Choose a reason for hiding this comment

uniqueg left a comment

Choose a reason for hiding this comment

uniqueg Sep 2, 2024

Choose a reason for hiding this comment

uniqueg Sep 2, 2024

Choose a reason for hiding this comment

JaeAeich commented Aug 31, 2024 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Aug 31, 2024 •

edited

Loading