You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@solr.apache.org by "gerlowskija (via GitHub)" <gi...@apache.org> on 2023/12/07 15:27:31 UTC
[PR] SOLR-16880: Add OAS to 'assembleRelease' task [solr]
gerlowskija opened a new pull request, #2125:
URL: https://github.com/apache/solr/pull/2125
This adds our OAS to the release artifacts gathered by the 'assembleRelease' task in gradle. It produces a checksum for the OAS file and stores the file in a separate 'oas' directory (similar to the 'changes' directory which already exists for Changes.html).
One remaining piece here is signing - this commit attempts to produce an '*.asc' signature for the OAS when signing is enabled, but doesn't quite have it working yet.
https://issues.apache.org/jira/browse/SOLR-16880
# Description
Solr has, for some time, produced an OpenAPI spec ("OAS") describing its v2 APIs that it uses to (e.g.) generate Solr clients in various languages. But while it uses the file internally, Solr doesn't (yet) expose the file to users who may wish to do similar things.
# Solution
This PR proposes that we publish our openapi spec as a release artifact akin to the various Changes.html files that we also put in artifacts.apache.org. It does this by modifying the gradle tasks (esp. 'assembleRelease') in the 'distribution' gradle module.
# Tests
Manual testing via the `buildAndPushRelease.py` script and the smoke tester.
# Checklist
Please review the following and check all that apply:
- [x] I have reviewed the guidelines for [How to Contribute](https://wiki.apache.org/solr/HowToContribute) and my code conforms to the standards described there to the best of my ability.
- [x] I have created a Jira issue and added the issue ID to my pull request title.
- [x] I have given Solr maintainers [access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to contribute to my PR branch. (optional but recommended)
- [x] I have developed this patch against the `main` branch.
- [ ] I have run `./gradlew check`.
- [ ] I have added documentation for the [Reference Guide](https://github.com/apache/solr/tree/main/solr/solr-ref-guide)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
Re: [PR] SOLR-16880: Add OAS to 'assembleRelease' task [solr]
Posted by "gerlowskija (via GitHub)" <gi...@apache.org>.
gerlowskija commented on PR #2125:
URL: https://github.com/apache/solr/pull/2125#issuecomment-1850287249
> Does anything test this, or must it be manually inspected?
I've been validating using the `buildAndPushRelease.py` script, paired with the smoketester. As far as I know we don't have anything else around that validates our build/release automation itself? This is one of the reasons I volunteered to be a possible RM over in `dev@`; I'd hate for something to go wrong and leave someone else on the hook for it.
----
Actually, finding the right invocation of `buildAndPushRelease.py` was a bit of a pain, so I'll share it here just in case it helps anyone that wants to validate or stumbles across a need down the road...
```
$ echo "foo" | gpg --detach-sign --use-agent --pinentry-mode loopback --local-user <keypair-fingerprint>
$ python3 -u dev-tools/scripts/buildAndPushRelease.py --push-local <some-output-dir> --rc-num 1 --mf-username gerlowskija --sign <keypair-fingerprint> --gpg-pass-noprompt
```
The first command sets up gpg-agent to delegate your password when buildAndPushRelease.py asks for it. It should prompt you for your password and then you're free to go "get some coffee", as the releaseWizard puts it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
Re: [PR] SOLR-16880: Add OAS to 'assembleRelease' task [solr]
Posted by "gerlowskija (via GitHub)" <gi...@apache.org>.
gerlowskija commented on PR #2125:
URL: https://github.com/apache/solr/pull/2125#issuecomment-1846143185
Alright, worked through the signing issues with some help (Thanks @HoustonPutman !). This should be functional and ready to go, assuming it's the route we want to take.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
Re: [PR] SOLR-16880: Add OAS to 'assembleRelease' task [solr]
Posted by "dsmiley (via GitHub)" <gi...@apache.org>.
dsmiley commented on code in PR #2125:
URL: https://github.com/apache/solr/pull/2125#discussion_r1419745012
##########
solr/api/build.gradle:
##########
@@ -28,7 +28,7 @@ ext {
jsClientDir = "${buildDir}/generated/js"
pythonClientDir = "${buildDir}/generated/python"
openApiSpecDir = "${buildDir}/generated/openapi"
- openApiSpecFile = "${project.openApiSpecDir}/openapi.json"
+ openApiSpecFile = "${project.openApiSpecDir}/solr-${version}-openapi.json"
Review Comment:
For JARs, the version is at the end. Maybe we should do similar? Just a thought.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
Re: [PR] SOLR-16880: Add OAS to 'assembleRelease' task [solr]
Posted by "gerlowskija (via GitHub)" <gi...@apache.org>.
gerlowskija commented on PR #2125:
URL: https://github.com/apache/solr/pull/2125#issuecomment-1845554961
One TODO remaining, if we choose to go this route, is to produce an "*.asc" signature for the OAS file. The PR currently contains some logic that tries to do this, but it's still not working for whatever reason. Something to work through at some point...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
Re: [PR] SOLR-16880: Add OAS to 'assembleRelease' task [solr]
Posted by "gerlowskija (via GitHub)" <gi...@apache.org>.
gerlowskija commented on PR #2125:
URL: https://github.com/apache/solr/pull/2125#issuecomment-1854108078
> Agree a better name is solr-openapi-x.y.z
OK, that makes sense. Will make that change later this morning and merge.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
Re: [PR] SOLR-16880: Add OAS to 'assembleRelease' task [solr]
Posted by "gerlowskija (via GitHub)" <gi...@apache.org>.
gerlowskija merged PR #2125:
URL: https://github.com/apache/solr/pull/2125
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
Re: [PR] SOLR-16880: Add OAS to 'assembleRelease' task [solr]
Posted by "dsmiley (via GitHub)" <gi...@apache.org>.
dsmiley commented on PR #2125:
URL: https://github.com/apache/solr/pull/2125#issuecomment-1846233632
Does anything test this, or must it be manually inspected? Basically, how do we have confidence that this is basically working?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org