feat: publish a cheat sheet via github pages #995
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #995 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 135 135
Lines 8919 8941 +22
Branches 2002 2008 +6
=========================================
+ Hits 8919 8941 +22 ☔ View full report in Codecov by Sentry. |
| url: ${{ steps.deployment.outputs.page_url }} | ||
| runs-on: ubuntu-latest | ||
| needs: build | ||
| steps: |
There was a problem hiding this comment.
Should we add a condition to skip the deployment if it is a pull-request: if: github.event_name != 'pull_request'?
There was a problem hiding this comment.
It is configured to only run after a push to main - I think this would automatically exclude pull requests?
There was a problem hiding this comment.
Seems the action is able to be executed from a branch: https://github.com/amazon-braket/amazon-braket-sdk-python/actions/runs/9390972449/job/25959406913
There was a problem hiding this comment.
Oh, I see, it can be manually executed. Yes, that should be fixed, thanks for catching that.
There was a problem hiding this comment.
It ran automatically the first time too. Wonder if it because it targets main.
Issue #, if available:
A cheat sheet is a good way to browse the BDK API to find quickly which functions to use.
Description of changes:
This PR:
Testing done:
N/A
Merge Checklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.General
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.