Light

wayofthepie / gram-cli Goto Github PK

View Code? Open in Web Editor NEW

1.0 4.0 0.0 99 KB

Cli for automating interactions with repositories

License: MIT License

Rust 100.00%

gram-cli's Introduction

Github Repo Automater

gram is a cli to help automate common repository tasks.

Usage

See the cli help for more information.

gram 0.1.0
Supported commands

USAGE:
    gram --token <token> <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -t, --token <token>    Github token to use [env: GITHUB_TOKEN=]

SUBCOMMANDS:
    help        Prints this message or the help of the given subcommand(s)
    settings    Interactions for repository settings

gram-cli's People

Contributors

Stargazers

Watchers

gram-cli's Issues

Support diff for branch protection settings

We should minimally support:

Check the branches with protection #23
Require pull request reviews before merging (including the number of required approvers)
- Require review from Code Owners
Require status checks to pass before merging
- Require branches to be up to date before merging (allow taking a list of status checks required)

Diff: Check the branches with protection

$ curl -s -u"${TOKEN}:" https://api.github.com/repos/wayofthepie/gram-cli/branches?protected=true
[
  {
    "name": "master",
    "commit": {
      "sha": "5c377b4509b894712f8c6cbfd82e58bc34a37889",
      "url": "https://api.github.com/repos/wayofthepie/gram-cli/commits/5c377b4509b894712f8c6cbfd82e58bc34a37889"
    },
    "protected": true,
    "protection": {
      "enabled": true,
      "required_status_checks": {
        "enforcement_level": "non_admins",
        "contexts": [
          "ci",
          "clippy"
        ]
      }
    },
    "protection_url": "https://api.github.com/repos/wayofthepie/gram-cli/branches/master/protection"
  }
]

Fix docs

There are some discrepancies in the docs, most importantly the ones structopt embeds in the cli.

Be careful about what gets into structopt docs

gram-cli/src/commands/mod.rs

Lines 23 to 30 in 339168b

    
           /// Supported commands and options. 
        
           /// 
        
           /// # Diff settings 
        
           /// `gram` supports diffing known settings defined in a settings toml file 
        
           /// against the current repository settings. 
        
           #[derive(Debug, StructOpt)] 
        
           #[structopt(name = "gram")] 
        
           pub struct GramOpt {

Need to be careful what docs get placed into structopt. The above is incorrect as when gram is run it looks like this:

Incorrect settings help

gram-cli/src/commands/mod.rs

Lines 9 to 21 in 339168b

    
           static SETTINGS_HELP: &str = concat!( 
        
               "Path to the settings file", 
        
               r#" 
        
           This is a toml file. For example: 
        
           ----------------------------------------- 
        
           description = "This is a test repository" 
        
           [settings] 
        
           merge.allow-squash = false 
        
           ----------------------------------------- 
        
           "# 
        
           );

This is outdated. It might be possible to try parse the settings here somehow with doc-tests, not exactly as is, but it would be worth doing if possible.

Diff support for delete branch on merge

The API call is:

$ curl -s -u"${TOKEN}:" https://api.github.com/repos/wayofthepie/gh-app-test \
    | grep delete_branch

  "delete_branch_on_merge": false,

Add apply action for settings

gram should be able to apply changes to settings as well as diff from expected.

Settings for PR review before merging

This corresponds to the following settings under Branch -> Add Rule.

RUSTSEC-2020-0016: `net2` crate has been deprecated; use `socket2` instead

net2 crate has been deprecated; use socket2 instead

Details
Status	unmaintained
Package	`net2`
Version	`0.2.34`
URL	deprecrated/net2-rs@`3350e38`
Date	2020-05-01

The net2 crate has been deprecated
and users are encouraged to considered socket2 instead.

See advisory page for additional details.

Improve error when settings file is a non-existant path

Currently if the path to the settings file does not exist an error will be thrown that could really be better:

$ gram diff-settings -o wayofthepie -r gh-app-test -s non_existent_file
Error: No such file or directory (os error 2)

We should at least mention the file that was passed:

Error: No such file or directory non_existent_file

The code is here:

gram-cli/src/commands/mod.rs

Line 228 in 339168b

let settings_str = self.read_to_string(settings_location)?;

Support for initial Options settings

Most of the repos I deal with have the following configuration from the Options menu:

Allow merge disabled
Allow squash disabled
Allow rebase enabled
Auto delete head branches enabled

So support for the above should be added initially. Along with support for two general settings - topics and description.

Add support

Description
Options -> Allow merge commit
Options -> Allow squash merge
Options -> Allow rebase merge
~~Topics~~ (will look at this one another time, not very important yet)

Add security audit action

Other repos I have that are rust have a security audit action. For example see the dockerfile-parser-rs security audit action.

name: security audit
on:
  schedule:
    - cron: "0 8 * * *"
  push:
    paths:
      - "Cargo.*"
  pull_request:
    branches:
      - master
jobs:
  security_audit:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - uses: actions-rs/audit-check@v1
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.

	/// Supported commands and options.
	///
	/// # Diff settings
	/// `gram` supports diffing known settings defined in a settings toml file
	/// against the current repository settings.
	#[derive(Debug, StructOpt)]
	#[structopt(name = "gram")]
	pub struct GramOpt {

	static SETTINGS_HELP: &str = concat!(
	"Path to the settings file",
	r#"

	This is a toml file. For example:
	-----------------------------------------
	description = "This is a test repository"

	[settings]
	merge.allow-squash = false
	-----------------------------------------
	"#
	);