Skip to content

github-tag-create.md

Latest commit

 

History

History
188 lines (127 loc) · 7.95 KB

github-tag-create.md

File metadata and controls

188 lines (127 loc) · 7.95 KB
layout command
title Command `github tag create`
lang en

github tag create

Create a tag on the repository (Experimental, and Irreversible operation)

Security

watermint toolbox stores credentials into the file system. That is located at below path:

OS Path
Windows %HOMEPATH%\.toolbox\secrets (e.g. C:\Users\bob.toolbox\secrets)
macOS $HOME/.toolbox/secrets (e.g. /Users/bob/.toolbox/secrets)
Linux $HOME/.toolbox/secrets (e.g. /home/bob/.toolbox/secrets)

Please do not share those files to anyone including Dropbox support. You can delete those files after use if you want to remove it. If you want to make sure removal of credentials, revoke application access from setting or the admin console.

Please see below help article for more detail:

Auth scopes

Description
GitHub: Grants full access to repositories, including private repositories. That includes read/write access to code, commit statuses, repository and organization projects, invitations, collaborators, adding team memberships, deployment statuses, and repository webhooks for repositories and organizations. Also grants ability to manage user projects.

Authorization

For the first run, tbx will ask you an authentication with your GitHub account. Press Enter to launch the browser. The service then performs the authorization and the application receives the results. You can close the browser window when you see the authentication success message.


watermint toolbox xx.x.xxx
==========================

© 2016-2025 Takayuki Okazaki
Licensed under open source licenses. Use the `license` command for more detail.

This project is no longer actively maintained. For more details, see: https://github.com/watermint/toolbox/discussions/911

Opening the authorization URL:
https://github.com/login/oauth/authorize?client_id=xxxxxxxxxxxxxxxxxxxx&redirect_uri=http%3A%2F%2Flocalhost%3A7800%2Fconnect%2Fauth&response_type=code&scope=repo&state=xxxxxxxx

Installation

Please download the pre-compiled binary from Latest Release. If you are using Windows, please download the zip file like tbx-xx.x.xxx-win.zip. Then, extract the archive and place tbx.exe on the Desktop folder. The watermint toolbox can run from any path in the system if allowed by the system. But the instruction samples are using the Desktop folder. Please replace the path if you placed the binary other than the Desktop folder.

Usage

This document uses the Desktop folder for command example.

Run

Windows:

cd $HOME\Desktop
.\tbx.exe github tag create -owner OWNER -repository REPO -sha1 SHA -tag TAG

macOS, Linux:

$HOME/Desktop/tbx github tag create -owner OWNER -repository REPO -sha1 SHA -tag TAG

Note for macOS Catalina 10.15 or above: macOS verifies Developer identity. Currently, tbx is not ready for it. Please select "Cancel" on the first dialogue. Then please proceed "System Preference", then open "Security & Privacy", select "General" tab. You may find the message like:

"tbx" was blocked from use because it is not from an identified developer.

And you may find the button "Allow Anyway". Please hit the button with your risk. At second run, please hit button "Open" on the dialogue.

Options:

-owner : Owner of the repository

-peer : Account alias. Default: default

-repository : Name of the repository

-sha1 : SHA1 hash of the commit

-tag : Tag name

Common options:

-auth-database : Custom path to auth database (default: $HOME/.toolbox/secrets/secrets.db)

-auto-open : Auto open URL or artifact folder. Default: false

-bandwidth-kb : Bandwidth limit in K bytes per sec for upload/download content. 0 for unlimited. Default: 0

-budget-memory : Memory budget (limits some feature to reduce memory footprint). Options: low, normal. Default: normal

-budget-storage : Storage budget (limits logs or some feature to reduce storage usage). Options: low, normal, unlimited. Default: normal

-concurrency : Maximum concurrency for running operation. Default: Number of processors

-debug : Enable debug mode. Default: false

-experiment : Enable experimental feature(s).

-extra : Extra parameter file path

-lang : Display language. Options: auto, en, ja. Default: auto

-output : Output format (none/text/markdown/json). Options: text, markdown, json, none. Default: text

-output-filter : Output filter query (jq syntax). The output of the report is filtered using jq syntax. This option is only applied when the report is output as JSON.

-proxy : HTTP/HTTPS proxy (hostname:port). Please specify DIRECT if you want to skip setting proxy.

-quiet : Suppress non-error messages, and make output readable by a machine (JSON format). Default: false

-retain-job-data : Job data retain policy. Options: default, on_error, none. Default: default

-secure : Do not store tokens into a file. Default: false

-skip-logging : Skip logging in the local storage. Default: false

-verbose : Show current operations for more detail.. Default: false

-workspace : Workspace path

Results

Report file path will be displayed last line of the command line output. If you missed the command line output, please see path below. [job-id] will be the date/time of the run. Please see the latest job-id.

OS Path pattern Example
Windows %HOMEPATH%\.toolbox\jobs\[job-id]\reports C:\Users\bob.toolbox\jobs\20190909-115959.597\reports
macOS $HOME/.toolbox/jobs/[job-id]/reports /Users/bob/.toolbox/jobs/20190909-115959.597/reports
Linux $HOME/.toolbox/jobs/[job-id]/reports /home/bob/.toolbox/jobs/20190909-115959.597/reports

Report: created

This report shows the transaction result. The command will generate a report in three different formats. created.csv, created.json, and created.xlsx.

Column Description
status Status of the operation
reason Reason of failure or skipped operation
input.owner Owner of the repository
input.repository Name of the repository
input.tag Tag name
input.sha_1 SHA1 hash of the commit
result.tag Tag name
result.sha SHA1 sum of the commit
result.message Message of the commit
result.url URL of the tag

If you run with -budget-memory low option, the command will generate only JSON format report.

In case of a report becomes large, a report in .xlsx format will be split into several chunks like follows; created_0000.xlsx, created_0001.xlsx, created_0002.xlsx, ...