Canonical SDK feature list #142
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…seable list of Ably SDK features.
…file. By adding the yaml extension to the prettier tool's remit I had started looping in this file, albeit not on macOS runners (explaining why it was failing in our Linux-based CI runner but not locally for me, macOS-based).
The file .markdownlint-cli2.yaml was being overlooked on macOS because of its dot prefix, despite failing our Linux-based CI.
For what it's worth, I first tried a "more clever" pattern but that caused a different failure:
ably-common % npm run lint
> ably-common@1.2.0 lint
> npm-run-all format:*:check
> ably-common@1.2.0 format:js-code:check
> eslint --max-warnings=0 .
> ably-common@1.2.0 format:data:check
> prettier --check **/{.*,*}.{json,yml,yaml}
Checking formatting...
[error] No files matching the pattern were found: "**/.*.yml".
All matched files use Prettier code style!
ERROR: "format:data:check" exited with 2.
?1
Initial import to establish tooling. There is more work to do to make it fully functional and to make it look nicer.
github-actions
bot
temporarily deployed
to
staging/pull/142/sdk-features
github-actions
bot
temporarily deployed
to
staging/pull/142/sdk-features
github-actions
bot
temporarily deployed
to
staging/pull/142/sdk-features
github-actions
bot
temporarily deployed
to
staging/pull/142/sdk-features
github-actions
bot
temporarily deployed
to
staging/pull/142/sdk-features
|
I'm back from some time off and am now going to re-assign this pull request to myself. @owenpearson and I have discussed the content and have agreed that the ephemeral notes markdown file should be removed, as it's not appropriate for addition to the Git index. If there are any parts of that file which I feel need to outlive this PR then I shall put them in a GitHub issue. |
github-actions
bot
temporarily deployed
to
staging/pull/142/sdk-features
QuintinWillison
requested review from
owenpearson,
stmoreau,
lmars,
tomkirbygreen,
Peter-Maguire,
ikbalkaya,
mattheworiordan,
paddybyers,
jaley and
tbuntel
tomkirbygreen
suggested changes
Jun 14, 2022
ikbalkaya
approved these changes
Jun 14, 2022
tomkirbygreen
approved these changes
Jun 14, 2022
tomkirbygreen
approved these changes
Jun 14, 2022
Peter-Maguire
approved these changes
Jun 14, 2022
stmoreau
approved these changes
Jun 15, 2022
AndyNicks
approved these changes
Jun 15, 2022
|
Thank you to everybody who has provided review input and/or approved this work. I'm going to merge it to |
lmars
reviewed
Jun 15, 2022
| - uses: ably/sdk-upload-action@v1 | ||
| with: | ||
| s3AccessKeyId: ${{ secrets.SDK_S3_ACCESS_KEY_ID }} | ||
| s3AccessKey: ${{ secrets.SDK_S3_ACCESS_KEY }} |
There was a problem hiding this comment.
Thanks. I've created #154
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Opus.
Early days on this pull request, which I expect to stay in a Draft state for a few days while I work on getting it ready for reviewers.In the meantime, I'm pushing the work up for visibility as I know various people are interested in how this work is evolving.I expect that I will feel this pull request is ready when the following have been completed:
features/README.mdpopulated, including descriptions of:features/ephemeral-notes.mdremovedsdk.ably.com, in order to allow us to manual inspect it