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

Replace Grunty on cubes for the zig zag on the Patcher page #542

Closed
brikis98 opened this issue Aug 3, 2021 · 4 comments · Fixed by #584
Closed

Replace Grunty on cubes for the zig zag on the Patcher page #542

brikis98 opened this issue Aug 3, 2021 · 4 comments · Fixed by #584
Assignees
Milestone

Comments

@brikis98
Copy link
Member

brikis98 commented Aug 3, 2021

Put in screenshots or .gif or more useful images to show what Patcher does.

@marinalimeira
Copy link
Contributor

Hey Jim, I will start to work on this one.

Before I jump in this one, do you have something in mind for the gifs/screenshots? Something like the Heroku page?

@brikis98
Copy link
Member Author

Thanks Marina!

Yes, I think screenshots or .gif images similar to Patcher would be right. E.g.,

  1. "Install the Patcher GitHub App" could be a screenshot of the GitHub UI when you go to install a GitHub App.
  2. "Patcher discovers your dependencies automatically" is an interesting one... Some ideas:
    1. A list of commonly supported formats: package.json, build.gradle, Gemfile, source URLs in .tf and .hcl files, Go.mod, Go.sum, etc.
    2. A mock up of some Patcher web UI that shows the list of dependencies we found in a given repo.
    3. The text from running the patcher CLI: e.g., some sort of patcher list-dependencies command that shows the list of dependencies found in a repo.
    4. An example of how to manually help Patcher find a version via a special comment (similar to these, but of course focused on Patcher, not RenovateBot).
    5. Looking at the list above, perhaps we do a few tabs: a "Supported dependency formats" tab with the list of supported formats (e.g., package.json), a "Inspecting dependencies" tab could show the patcher list-dependencies CLI output, and a "Manually define dependencies" tab could show a code snippet with a special comment.
  3. "Maintainers release new versions and patches" could have a couple tabs: one tab shows the releases page of some GitHub repo (e.g., our EKS repo) to show you release new versions "as usual," and the other tab shows an example Patch file.
  4. Etc.

These are just starting ideas, so feel free to get creative.

@marinalimeira
Copy link
Contributor

@brikis98 what is a patcher file? Its like a ruby script?

@brikis98
Copy link
Member Author

It's the file format we'll create to define patches (e.g., a patch to update from TF 0.14 -> 0.15). I don't know what the format will be yet; we'l have to design it. E.g., Could be a YAML file that declares transformations to run and/or scripts to execute; could be something else.

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

Successfully merging a pull request may close this issue.

2 participants