Skip to content

Conversation

@Junaid-Ashraf-56
Copy link
Contributor

Description

Updates the matrix-auth-plugin documentation to reflect the new syntax introduced in matrix-auth plugin version 3.2.

What I Did

  • Updated documentation to use the new entries: format for matrix-auth plugin 3.2+
  • Added examples for both globalMatrix and projectMatrix configurations using the new syntax
  • Included deprecated syntax examples for reference and migration guidance
  • Fixed inconsistencies in the original examples
  • Added a clear note about the syntax change at the top of the document

Changes Made

  1. Global Matrix Example: Updated to use entries: with separate user/group configurations
  2. Project Matrix Example: Updated to use entries: format and grouped permissions by principal
  3. Deprecated Examples: Added clearly marked deprecated configuration examples for both matrix types
  4. Migration Guidance: Added note about deprecated: warn option for backward compatibility

References

Testing

The documentation updates follow the exact syntax provided in the official matrix-auth 3.2 release notes and maintain backward compatibility information for users migrating from older versions.

@Junaid-Ashraf-56 Junaid-Ashraf-56 requested a review from a team as a code owner October 5, 2025 18:26
@Junaid-Ashraf-56
Copy link
Contributor Author

Please review my pull request, and if any problem, please guide me.

@timja timja added the documentation A PR that adds to documentation - used by Release Drafter label Oct 6, 2025
Copy link
Member

@timja timja left a comment

Choose a reason for hiding this comment

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

Thanks for this PR! It looks good, few minor changes that would make this better.

## sample-configuration (project based matrix)
```yaml
jenkins:
Copy link
Member

Choose a reason for hiding this comment

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

Could you update the integration test to use this to prove it works please (and continues to work):

https://github.com/jenkinsci/configuration-as-code-plugin/blob/master/integrations/src/test/java/io/jenkins/plugins/casc/ProjectMatrixAuthorizationTest.java

It will need to change to use the JenkinsConfiguredWithReadmeRule

You can then append #<heading-number> to the ConfiguredWithReadme so that it uses the right example, like in:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is a pleasure for me to work on the repo.

Copy link
Member

Choose a reason for hiding this comment

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

you haven't done this

@Junaid-Ashraf-56
Copy link
Contributor Author

Thank you @timja for your thoughtful review and guidance throughout this PR.

Junaid-Ashraf-56

This comment was marked as off-topic.

@timja
Copy link
Member

timja commented Oct 8, 2025

Please don't mark comments as resolved until you've pushed the fix

@Junaid-Ashraf-56
Copy link
Contributor Author

I have updated the pr according to the requirement.

Junaid-Ashraf-56 added 3 commits October 14, 2025 15:10
@timja timja enabled auto-merge (squash) October 19, 2025 07:45
@timja timja merged commit f5d61d3 into jenkinsci:master Oct 19, 2025
14 of 15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation A PR that adds to documentation - used by Release Drafter

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants