Skip to content
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

Development #8

Open
wants to merge 30 commits into
base: main
Choose a base branch
from
Open

Development #8

wants to merge 30 commits into from

Conversation

jtalborough
Copy link
Contributor

New Features

1.	Package Name Validation (New Feature)
•	Adds a step to validate the NuGet package name according to the repository naming convention, ensuring consistent package identifiers. This step includes an option to bypass the validation if necessary.
2.	Commit Message Validation Workflow (New Feature)
•	Implements a new workflow to enforce the Conventional Commits format, verifying that commit messages adhere to a standard format. This check is designed to improve clarity and uniformity in commit history and includes an option to bypass validation if needed.
3.	Automated README Update Workflow (New Feature)
•	Adds a dedicated workflow to automate README updates by running a Python script, capturing key metadata and configuration details for the project. This ensures that documentation is kept up-to-date across branches without manual intervention.

Additional Fixes and Enhancements

1.	Artifact Path Update
•	Fixes the artifact path pattern to ensure the correct files are handled and uploaded during the build process.
2.	NuSpec File Management
•	Adds the creation and cleanup of the .nuspec file within the workflow, ensuring consistency in package generation.
3.	Indentation Correction
•	Adjusts indentation within the NuSpec file creation step to improve readability and prevent formatting issues in YAML.
4.	Enhanced Error Handling
•	Improves error handling for NuGet package checks, providing clearer error messages for package name mismatches.

Copy link
Contributor

Choose a reason for hiding this comment

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

This one is good, but only gets the last commit. There could be multiple commits that need to be checked since the last tag. I'd suggest getting all commits since the last relevant tag.


steps:
- name: Checkout Caller Repository
uses: actions/checkout@v3
Copy link
Contributor

Choose a reason for hiding this comment

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

Should update the actions/checkout version to v4

Copy link
Contributor

Choose a reason for hiding this comment

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

Might be worth it to push it to the same branch as triggered the commit rather than a robot-docs branch, as well as only trigger this one on PR.

We should also find a way to only trigger this one if something changed that affects what goes in the readme. For instance if the join map changed or something like that.

- Add extract_public_feedbacks function to parse BoolFeedback, IntFeedback, and StringFeedback
- Update read_files_in_directory to collect feedback information
- Add feedback sections to README.md generation
- Update regex patterns to match property-style feedback declarations
- Add support for both field and property-style feedback syntax
- Add filtering to clean whitespace from extracted feedback names
jtalborough and others added 5 commits December 4, 2024 11:32
- Add support for property-style feedback declarations
- Enhance regex patterns to match all feedback formats
- Fix feedback detection in C# files with get/private set
- Include initialization with equals sign pattern
- Add target directory argument to metadata.py script execution
- Add debug output (pwd and ls) to help troubleshoot GitHub workflow
- Fix script execution path to work with readme-automation checkout
- Remove redundant workflow repository checkout
- Use script directly from workflow repository via github.workspace
- Fix target directory path to point to caller's repository root
- Add separate checkouts for caller and workflow repositories
- Set working directory to caller's repository
- Fix script path to reference workflow repository
- Remove debug commands
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants