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

Define and document standard filename and location for feature manifest files in SDK repositories #6

Closed
QuintinWillison opened this issue Jul 5, 2022 · 3 comments · Fixed by #8
Assignees

Comments

@QuintinWillison
Copy link
Contributor

QuintinWillison commented Jul 5, 2022

This will be a quick enough thing to decide on and document, however should be presented to the wider team for consideration before concluding the conformed naming.

For context, see Future Direction for the SDK Manifests.

┆Issue is synchronized with this Jira Uncategorised by Unito

@QuintinWillison
Copy link
Contributor Author

Making a comment as a trigger in order to attempt to get our Github to Jira sync tool to bring this issue into Jira. Sorry for the noise.

@deanna-lad deanna-lad added the sdk label Jul 6, 2022
@QuintinWillison
Copy link
Contributor Author

Thanks, @deanna-lad. The lack of sync was my fault, for having not added the sdk label. Sorry for the noise.

@QuintinWillison QuintinWillison self-assigned this Jul 6, 2022
@QuintinWillison
Copy link
Contributor Author

We've settled on .ably/capabilities.yaml.

See this internal Slack thread for full context, where it was this comment from @lawrence-forooghian that introduced the excellent idea of having an intermediary .ably folder:

We could also take the GitHub approach and have a .ably-tooling (naming up for debate) directory at the root of the repo – I’ve already been thinking about other manifest-like files that I’d like to put in a repo (for providing extra metadata for test observability, for example). Just a thought.

(we dropped the -tooling suffix)

And it was this comment @Rosalita that moved us from 'manifest' to 'capabilities' in respect of the file name, which is much more friendly 😁:

I have no strong opinions on this, but wanted to ask the question, as this is an internal tool should the name contain the word ably e.g. ably-features-manifest.yaml or ably-capabilities.yaml the thinking here is to distinguish it as a file for an internal tool, rather than a file that runs CI or something similar.

Work that now remains to be done under this issue is to document this, probably within the root readme of our new ably/features repository (see ably/ably-common#70 (comment)).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging a pull request may close this issue.

2 participants