-
Notifications
You must be signed in to change notification settings - Fork 61
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
feat: add helia-script-tag example #13
feat: add helia-script-tag example #13
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice! I can see the node go online! but from a reader's point of view I think we can change a few things.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I saw this in other examples too, should this file be in the root like .github/workflows/ci.yml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, this gets copied to the per-example repo and is used when a user tries to open a PR there - for example: https://github.com/ipfs-examples/helia-101/blob/main/.github/pull_request_template.md
If we placed this in the root of this repo, it would show a "Please don't open a PR here" message when someone tried to open a PR here, which is not what we want.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there some documentation we should add so that is clearer for contributors? What would have helped you @whizzzkid ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can have an example generator which updates and maintains boilerplate stuff.
This looks quite hectic.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the generator is simply forking an example and then continuing. I don't want to maintain a generator, and I don't want to break the ipfs-examples or fork&go pattern without good reason and less work
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see this in other examples too, is this only to sync feature branches?
Questions (Most likely for @achingbrain):
- can't this be in the root alongside
workflow.yml
- github has a setting to force branch update and merge queue which also achieves something similar, how's this different? seems boilerplate overhead.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is copied to the per-example repo and is then triggered by CI on this repo, it pulls a subfolder from this repo to the per-example repo and replaces all the files there.
I would rather the changes were pushed from a build on this repo instead of triggering a pull from every per-example repo but GitHub's permissions model prevented it, at the time at least.
If there's a better way of doing this PRs are gratefully accepted!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we could do similar to what exists in our {org}/.github-mgmt repos, or unified CI, where files that are to be copied to other repos are in a central location, and we copy/override example subfolders & commit before pushing to example repos.
This is probably already supported by https://github.com/ipfs-examples/github-mgmt with the repositories.*.files.content
key for each repo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- you can request permissions at https://github.com/ipfs-examples/github-mgmt
- I don't think we need to provide signposts back to js-ipfs-examples. This can live on its own.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there some documentation we should add so that is clearer for contributors? What would have helped you @whizzzkid ?
Co-authored-by: Alex Potsides <[email protected]>
I was thinking similar, but I wanted to fill out the readme appropriately. i'll look to the original example's readme and see what I can pull here instead of calling it out. |
Co-authored-by: Nishant Arora <[email protected]>
Co-authored-by: Nishant Arora <[email protected]>
Given we're factoring out the common stuff after, it seems good to me on that front. |
Note: I do not have permissions to create ipfs-examples/helia-script-tag repo.
demo: https://codesandbox.io/p/sandbox/helia-script-tag-g420c3
codepen example also available: https://codepen.io/SgtPooki/pen/dyqKVqx