sous-chefs / sous-chefs/github

Support for github assets based on branches/revisions

Open
#19 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature Request
Dominant language
Ruby
Stars
25
Forks
25
Avg merge
5h 40m
Merged PRs (30d)
1

Description

:person_frowning: Problem Statement

Currently, github_asset seems to only support getting assets based on a tag, which involves a release happening. If I wanted to test a feature across repos, I would have to cut a new release from that feature branch, or that feature branch being merged into HEAD, updating the revision tag for the cookbook, running my integration tests, and repeat the cycle if any issues crop up.

❔ Possible Solution

Add support for specifying a branch/revision and using octokit to check out the code and the needed files at that point in time, as an alternative to tags.

⤴️ Describe alternatives you've considered

The alternative would be a draft release, which is something I'll trial shortly, but it still involves a potential draft release for something that might not be ready.

I'd love to get your thoughts on the matter though, and whether this is feasible or not.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the cookbook for the github_asset implementation and trace how tag-based assets are currently resolved. Review the existing Octokit usage, if present, and define how a branch or revision should identify the needed files. Done means assets can be retrieved from a branch or revision without creating a release, with tests or documentation covering the new behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, ruby
Domain
devops
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.