├── 1 ├── whisper │ └── transcription.json └── metadata │ └── info.json ├── requirements.txt ├── .github ├── ISSUE_TEMPLATE │ ├── captions.yml │ └── whisper.yml └── workflows │ ├── ensure_labels.yml │ └── issue_created.yml ├── transcribe_audio.py ├── README.md └── LICENSE /requirements.txt: -------------------------------------------------------------------------------- 1 | yt-dlp 2 | webvtt-to-json>=0.2 3 | ttml-to-json>=0.2 4 | replicate 5 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/captions.yml: -------------------------------------------------------------------------------- 1 | name: Extract captions 2 | description: Save the captions from a vieo 3 | title: "Extract captions" 4 | labels: ["captions"] 5 | body: 6 | - type: input 7 | id: url 8 | attributes: 9 | label: URL 10 | description: URL to a video 11 | validations: 12 | required: true 13 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/whisper.yml: -------------------------------------------------------------------------------- 1 | name: Extract and transcribe audio with Whisper 2 | description: Uses Whisper to transcribe audio. This has a small cost associated with it, which depends on the length of the video. 3 | title: "Transcribe audio" 4 | labels: ["whisper"] 5 | body: 6 | - type: input 7 | id: url 8 | attributes: 9 | label: URL 10 | description: URL to a video 11 | validations: 12 | required: true 13 | -------------------------------------------------------------------------------- /.github/workflows/ensure_labels.yml: -------------------------------------------------------------------------------- 1 | name: Ensure labels 2 | on: [push] 3 | 4 | jobs: 5 | ensure_labels: 6 | runs-on: ubuntu-latest 7 | steps: 8 | - name: Create labels 9 | uses: actions/github-script@v6 10 | with: 11 | script: | 12 | try { 13 | await github.rest.issues.createLabel({ 14 | ...context.repo, 15 | name: 'captions' 16 | }); 17 | await github.rest.issues.createLabel({ 18 | ...context.repo, 19 | name: 'whisper' 20 | }); 21 | } catch(e) { 22 | // Ignore if labels exist already 23 | } 24 | -------------------------------------------------------------------------------- /transcribe_audio.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import replicate 3 | import json 4 | 5 | 6 | def transcribe_audio(filepath): 7 | model = replicate.models.get("cjwbw/whisper") 8 | return model.predict( 9 | audio=open(filepath, "rb"), 10 | model="large", 11 | translate=True 12 | ) 13 | 14 | 15 | if __name__ == "__main__": 16 | audio_path = sys.argv[-2] 17 | output_path = sys.argv[-1] 18 | if not audio_path.endswith(".mp3"): 19 | print("Please provide an mp3 file") 20 | sys.exit(1) 21 | if not output_path.endswith(".json"): 22 | print("Please provide a .json output file") 23 | sys.exit(1) 24 | output = transcribe_audio(audio_path) 25 | open(output_path, "w").write(json.dumps(output, indent=2) + "\n") 26 | -------------------------------------------------------------------------------- /1/whisper/transcription.json: -------------------------------------------------------------------------------- 1 | { 2 | "translation": " We are taking our first step signing the application of Ukraine in the accelerated order to NATO. We are taking our first step signing the application of Ukraine in the accelerated order to NATO.", 3 | "transcription": " \u041c\u044b \u0434\u0435\u043b\u0430\u0435\u043c \u0441\u0432\u043e\u0439 \u0432\u0438\u0437\u043d\u0430\u0447\u0430\u043b\u044c\u043d\u044b\u0439 \u0448\u0430\u0433, \u043f\u043e\u0434\u043f\u0438\u0441\u044b\u0432\u0430\u044f \u0437\u0430\u044f\u0432\u043a\u0443 \u0423\u043a\u0440\u0430\u0438\u043d\u044b \u043d\u0430 \u0432\u0445\u043e\u0434 \u0432 \u0443\u0441\u043a\u043e\u0440\u0435\u043d\u043d\u043e\u043c \u043f\u043e\u0440\u044f\u0434\u043a\u0435 \u0432 \u041d\u0410\u0422\u041e. \u041c\u044b \u0434\u0435\u043b\u0430\u0435\u043c \u0441\u0432\u043e\u0439 \u0432\u0438\u0437\u043d\u0430\u0447\u0430\u043b\u044c\u043d\u044b\u0439 \u0448\u0430\u0433, \u043f\u043e\u0434\u043f\u0438\u0441\u044b\u0432\u0430\u044f \u0437\u0430\u044f\u0432\u043a\u0443 \u0423\u043a\u0440\u0430\u0438\u043d\u044b \u043d\u0430 \u0432\u0445\u043e\u0434 \u0432 \u0443\u0441\u043a\u043e\u0440\u0435\u043d\u043d\u043e\u043c \u043f\u043e\u0440\u044f\u0434\u043a\u0435 \u0432 \u041d\u0410\u0422\u041e.", 4 | "detected_language": "russian" 5 | } 6 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Action Transcription 2 | 3 | ## Team Members 4 | 5 | Simon Willison - [@simonw](https://twitter.com/simonw) - [simonwillison.net](https://simonwillison.net/) 6 | 7 | For more on this project: [A tool to run caption extraction against online videos using Whisper and GitHub Issues/Actions](https://simonwillison.net/2022/Sep/30/action-transcription/) 8 | 9 | ## Tool Description 10 | 11 | Action Transcription supports archiving and searching the transcripts of videos from multiple different video hosting platforms. 12 | 13 | It runs on GitHub to take advantage of the free GitHub Actions code running mechanism - but importantly it does not require any use any tools aside from the user's browser, even to setup new instances of the tool. 14 | 15 | If a video has captions, this tool can be used to retrieve and store those captions. 16 | 17 | If a video does not have captions, the tool can extract the audio from the video and run it through [Whisper](https://openai.com/blog/whisper/) - a new, state-of-the-art speech-to-text tool from OpenAI. 18 | 19 | ## Demo 20 | 21 | A demo version of this tool can be found at [simonw/action-transcription-demo](https://github.com/simonw/action-transcription-demo). 22 | 23 | - [Example issue with a VK video transcribed to English using Whisper](https://github.com/simonw/action-transcription-demo/issues/3) 24 | - [Example issue that extracted YouTube auto-generated English captions](https://github.com/simonw/action-transcription-demo/issues/4) 25 | 26 | ## Installation 27 | 28 | This GitHub repository acts as a "template repository" - you can create your own copy of the repository [using this form](https://github.com/simonw/action-transcription/generate). 29 | 30 | These can be created public or private - public repos get an additional feature and are free to run, while private repos have additional cost. 31 | 32 | If you wish to use the "Whisper" integration you will need to create an account on [Replicate](https://replicate.com/), then copy the API token from that account and create a new GitHub Actions secret in your repository called `REPLICATE_API_TOKEN`. Transcribing videos costs money - usually around $0.20 per minute of audio. 33 | 34 | ## Usage 35 | 36 | Usage of the tool is through filing GitHub Issues. 37 | 38 | Issues must include the URL to the video you want to transcribe in the issue body. 39 | 40 | You can tag the issue with "captions" to extract captions from the video hosting provider (which is free), or "whisper" to transcribe the audio using Whisper (which costs money). 41 | 42 | Note that "whisper" transcriptions only work on shorter videos: up to five minutes should be OK, but longer than that is likely to fail with a timeout error. 43 | 44 | In public repos, issue templates are provided which help further guide the user through the process. Here's a demo: 45 | 46 | ![Animated demo. Click Issues, then New Issue, then select Get Started on the Capture captions menu option. Paste in a URL and click Submit new issue.](https://user-images.githubusercontent.com/9599/192150032-43b4eb68-aa39-449f-b932-f55a95c4611c.gif) 47 | 48 | The results of the operation will be posted in a comment on the issue, and will also be written to the GitHub repository for permanent storage. 49 | 50 | ## Additional Information 51 | 52 | The pattern I am most excited about here is the way this shows that GitHub Issues can be used to create a hopefully not-too-intimidating interface for users, which can trigger real code to be run for free by the GitHub Actions platform. 53 | 54 | My next step with this project will be to add a custom search engine that can be used to search the transcripts of the videos. I intend to build this using [Datasette Lite](https://lite.datasette.io/). 55 | 56 | Original development took place in the issues in the [action-transcription-prototype](https://github.com/simonw/action-transcription-prototype) repository. 57 | -------------------------------------------------------------------------------- /1/metadata/info.json: -------------------------------------------------------------------------------- 1 | {"id":"1575854699542368258","title":"EHA News - 📹 | #BREAKING: #Ukraine's President #Zelensky signs #NATO application.","description":"📹 | #BREAKING: #Ukraine's President #Zelensky signs #NATO application. https://t.co/7axcF8KfAv","uploader":"EHA News","timestamp":1664548012,"uploader_id":"eha_news","uploader_url":"https://twitter.com/eha_news","like_count":28,"repost_count":20,"comment_count":10,"age_limit":0,"tags":["BREAKING","Ukraine","Zelensky","NATO"],"formats":[{"format_id":"hls-256","url":"https://video.twimg.com/ext_tw_video/1575854662057697281/pu/pl/478x270/p96I_KwV9_PVM0Cu.m3u8?container=fmp4","manifest_url":"https://video.twimg.com/ext_tw_video/1575854662057697281/pu/pl/Ha8G-OndG_2jCYD1.m3u8?tag=12&container=fmp4","tbr":256,"ext":"mp4","protocol":"m3u8_native","width":478,"height":270,"vcodec":"avc1.4d001e","acodec":"mp4a.40.2","dynamic_range":"SDR","video_ext":"mp4","audio_ext":"none","vbr":256,"abr":0,"format":"hls-256 - 478x270","resolution":"478x270","filesize_approx":1391984,"http_headers":{"User-Agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.159 Safari/537.36","Accept":"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8","Accept-Language":"en-us,en;q=0.5","Sec-Fetch-Mode":"navigate"}},{"url":"https://video.twimg.com/ext_tw_video/1575854662057697281/pu/vid/478x270/ndd4lGJOB9uhqGZT.mp4?tag=12","format_id":"http-256","tbr":256,"width":478,"height":270,"protocol":"https","ext":"mp4","video_ext":"mp4","audio_ext":"none","vbr":256,"abr":0,"format":"http-256 - 478x270","resolution":"478x270","dynamic_range":"SDR","filesize_approx":1391984,"http_headers":{"User-Agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.159 Safari/537.36","Accept":"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8","Accept-Language":"en-us,en;q=0.5","Sec-Fetch-Mode":"navigate"}},{"format_id":"hls-832","url":"https://video.twimg.com/ext_tw_video/1575854662057697281/pu/pl/718x404/ABr2hV1hqVBMBumU.m3u8?container=fmp4","manifest_url":"https://video.twimg.com/ext_tw_video/1575854662057697281/pu/pl/Ha8G-OndG_2jCYD1.m3u8?tag=12&container=fmp4","tbr":832,"ext":"mp4","protocol":"m3u8_native","width":718,"height":404,"vcodec":"avc1.4d001f","acodec":"mp4a.40.2","dynamic_range":"SDR","video_ext":"mp4","audio_ext":"none","vbr":832,"abr":0,"format":"hls-832 - 718x404","resolution":"718x404","filesize_approx":4523950,"http_headers":{"User-Agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.159 Safari/537.36","Accept":"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8","Accept-Language":"en-us,en;q=0.5","Sec-Fetch-Mode":"navigate"}},{"url":"https://video.twimg.com/ext_tw_video/1575854662057697281/pu/vid/718x404/bXl_YyxIlFf0xmH0.mp4?tag=12","format_id":"http-832","tbr":832,"width":718,"height":404,"protocol":"https","ext":"mp4","video_ext":"mp4","audio_ext":"none","vbr":832,"abr":0,"format":"http-832 - 718x404","resolution":"718x404","dynamic_range":"SDR","filesize_approx":4523950,"http_headers":{"User-Agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.159 Safari/537.36","Accept":"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8","Accept-Language":"en-us,en;q=0.5","Sec-Fetch-Mode":"navigate"}}],"subtitles":{},"thumbnails":[{"id":"thumb","url":"https://pbs.twimg.com/ext_tw_video_thumb/1575854662057697281/pu/img/nsfM9IWxvJAF4D8k.jpg?name=thumb","width":150,"height":150,"resolution":"150x150"},{"id":"small","url":"https://pbs.twimg.com/ext_tw_video_thumb/1575854662057697281/pu/img/nsfM9IWxvJAF4D8k.jpg?name=small","width":680,"height":383,"resolution":"680x383"},{"id":"large","url":"https://pbs.twimg.com/ext_tw_video_thumb/1575854662057697281/pu/img/nsfM9IWxvJAF4D8k.jpg?name=large","width":718,"height":404,"resolution":"718x404"},{"id":"medium","url":"https://pbs.twimg.com/ext_tw_video_thumb/1575854662057697281/pu/img/nsfM9IWxvJAF4D8k.jpg?name=medium","width":718,"height":404,"resolution":"718x404"},{"id":"orig","url":"https://pbs.twimg.com/ext_tw_video_thumb/1575854662057697281/pu/img/nsfM9IWxvJAF4D8k.jpg?name=orig","width":718,"height":404,"resolution":"718x404"}],"duration":42.48,"webpage_url":"https://twitter.com/eha_news/status/1575854699542368258","webpage_url_basename":"1575854699542368258","webpage_url_domain":"twitter.com","extractor":"twitter","extractor_key":"Twitter","thumbnail":"https://pbs.twimg.com/ext_tw_video_thumb/1575854662057697281/pu/img/nsfM9IWxvJAF4D8k.jpg?name=orig","display_id":"1575854699542368258","fulltitle":"EHA News - 📹 | #BREAKING: #Ukraine's President #Zelensky signs #NATO application.","duration_string":"42","upload_date":"20220930","url":"https://video.twimg.com/ext_tw_video/1575854662057697281/pu/vid/718x404/bXl_YyxIlFf0xmH0.mp4?tag=12","format_id":"http-832","tbr":832,"width":718,"height":404,"protocol":"https","ext":"mp4","video_ext":"mp4","audio_ext":"none","vbr":832,"abr":0,"format":"http-832 - 718x404","resolution":"718x404","dynamic_range":"SDR","filesize_approx":4523950,"http_headers":{"User-Agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.159 Safari/537.36","Accept":"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8","Accept-Language":"en-us,en;q=0.5","Sec-Fetch-Mode":"navigate"},"epoch":1664552278,"_type":"video","_version":{"version":"2022.09.01","release_git_head":"5d7c7d6","repository":"yt-dlp/yt-dlp"}} 2 | -------------------------------------------------------------------------------- /.github/workflows/issue_created.yml: -------------------------------------------------------------------------------- 1 | on: 2 | issues: 3 | types: [opened] 4 | 5 | jobs: 6 | issue_created: 7 | runs-on: ubuntu-latest 8 | if: contains('["OWNER", "COLLABORATOR", "MEMBER"]', github.event.issue.author_association) 9 | steps: 10 | - uses: actions/checkout@v3 11 | - uses: actions/setup-python@v4 12 | with: 13 | python-version: '3.10' 14 | cache: 'pip' 15 | - run: pip install -r requirements.txt 16 | - run: sudo apt-get -y install ffmpeg 17 | if: contains(github.event.issue.labels.*.name, 'whisper') 18 | - uses: actions/github-script@v6 19 | if: contains(github.event.issue.labels.*.name, 'whisper') || contains(github.event.issue.labels.*.name, 'captions') 20 | name: Save metadata 21 | with: 22 | script: | 23 | // yt-dlp 'https://www.youtube.com/watch?v=...' --skip-download --write-info-json 24 | const child_process = require('child_process'); 25 | const fs = require('fs'); 26 | const body = context.payload.issue.body; 27 | let match = body.match(/https?:\/\/[^\s]+/); 28 | // Ignore github.com URLs 29 | if (match && match[0].includes('https://github.com')) { 30 | match = null; 31 | } 32 | if (!match) { 33 | return; 34 | } 35 | const url = match[0]; 36 | const number = context.issue.number.toString(); 37 | child_process.spawnSync('mkdir', ['-p', `${number}/metadata-temp`]); 38 | child_process.spawnSync('mkdir', ['-p', `${number}/metadata`]); 39 | child_process.spawnSync('yt-dlp', [url, '--skip-download', '--write-info-json'], { 40 | cwd: `${number}/metadata-temp` 41 | }); 42 | // Rename to info.json 43 | child_process.exec(`cat ${number}/metadata-temp/*.json | jq 'del(.automatic_captions)' -c > ${number}/metadata/info.json`); 44 | child_process.exec(`rm ${number}/metadata-temp/*.json`); 45 | - uses: actions/github-script@v6 46 | name: Extract captions 47 | # Only run this step if the issue is labeled with "captions" 48 | if: contains(github.event.issue.labels.*.name, 'captions') 49 | with: 50 | script: | 51 | const child_process = require('child_process'); 52 | const fs = require('fs'); 53 | const body = context.payload.issue.body; 54 | let match = body.match(/https?:\/\/[^\s]+/); 55 | // Ignore github.com URLs 56 | if (match && match[0].includes('https://github.com')) { 57 | match = null; 58 | } 59 | if (!match) { 60 | github.rest.issues.createComment({ 61 | issue_number: context.issue.number, 62 | owner: context.repo.owner, 63 | repo: context.repo.repo, 64 | body: '🚫 No URL found in issue body.' 65 | }); 66 | return; 67 | } 68 | const url = match[0]; 69 | // Create directory named after the issue number 70 | const number = context.issue.number.toString(); 71 | child_process.spawnSync('mkdir', ['-p', number]); 72 | // Create subdirectories subs, auto, whisper 73 | child_process.spawnSync('mkdir', ['-p', `${number}/subs`]); 74 | child_process.spawnSync('mkdir', ['-p', `${number}/auto`]); 75 | let results = []; 76 | 77 | function run(command, args, cwd) { 78 | // Returns [status stdout, stderr] 79 | const options = { 80 | cwd: cwd, 81 | encoding: 'utf-8', 82 | }; 83 | const result = child_process.spawnSync(command, args, options); 84 | return [result.status, result.stdout, result.stderr]; 85 | } 86 | results.push(run('yt-dlp', ['--all-subs', '--skip-download', '--sub-format', 'ttml/vtt/best', url], `${number}/subs`)); 87 | // Did that create any files? 88 | const files = child_process.spawnSync('ls', [`${number}/subs`]); 89 | if (files.stdout.toString().trim() === '') { 90 | // Use --write-auto-sub 91 | results.push(run('yt-dlp', ['--write-auto-sub', '--skip-download', '--sub-format', 'ttml/vtt/best', url], `${number}/auto`)); 92 | // Now delete all but the `ru` and `en` files 93 | const autoFiles = fs.readdirSync(`${number}/auto`); 94 | autoFiles.forEach(file => { 95 | if (!file.includes('.ru.') && !file.includes('.en.')) { 96 | fs.unlinkSync(`${number}/auto/${file}`); 97 | } 98 | }); 99 | } 100 | const comment = results.map(result => { 101 | return `\`\`\` + ${result[0]}\n${result[1]}\n${result[2]}\`\`\``; 102 | }).join('\n'); 103 | // Post the output as a comment 104 | github.rest.issues.createComment({ 105 | issue_number: context.issue.number, 106 | owner: context.repo.owner, 107 | repo: context.repo.repo, 108 | body: comment, 109 | }); 110 | // Generate a comment with the result from .ttml or .vtt files 111 | for (const format of ['ttml', 'vtt']) { 112 | const globber = await glob.create(`${number}/**/*.${format}`); 113 | const foundFiles = await globber.glob(); 114 | if (foundFiles.length) { 115 | // Pass it through XXXX-to-json 116 | let args = [foundFiles[0]]; 117 | let command = null; 118 | if (format === 'vtt') { 119 | args.push('--dedupe'); 120 | command = 'webvtt-to-json'; 121 | } else { 122 | command = 'ttml-to-json'; 123 | } 124 | const captions = JSON.parse( 125 | child_process.spawnSync(command, args, { 126 | encoding: 'utf-8', 127 | } 128 | ).stdout); 129 | github.rest.issues.createComment({ 130 | issue_number: context.issue.number, 131 | owner: context.repo.owner, 132 | repo: context.repo.repo, 133 | body: '```\n' + captions.map(caption => caption.lines.join('\n')).join('\n') + '\n```', 134 | }); 135 | break; 136 | } 137 | } 138 | // Close the issue 139 | github.rest.issues.update({ 140 | issue_number: context.issue.number, 141 | owner: context.repo.owner, 142 | repo: context.repo.repo, 143 | state: 'closed' 144 | }); 145 | - uses: actions/github-script@v6 146 | name: Run it through whisper 147 | # Only run this step if the issue is labeled with "whisper" 148 | if: contains(github.event.issue.labels.*.name, 'whisper') 149 | env: 150 | REPLICATE_API_TOKEN: ${{ secrets.REPLICATE_API_TOKEN }} 151 | with: 152 | script: | 153 | const child_process = require('child_process'); 154 | const fs = require('fs'); 155 | const body = context.payload.issue.body; 156 | let match = body.match(/https?:\/\/[^\s]+/); 157 | // Ignore github.com URLs 158 | if (match && match[0].includes('https://github.com')) { 159 | match = null; 160 | } 161 | if (!match) { 162 | return; 163 | } 164 | const url = match[0]; 165 | // Create directory named after the issue number 166 | const number = context.issue.number.toString(); 167 | child_process.spawnSync('mkdir', ['-p', `${number}/whisper`]); 168 | // Use yt-dlp to extract the audio 169 | console.log(child_process.spawnSync('yt-dlp', [ 170 | '-x', url, '--audio-format', 'mp3', '--output', `${number}/whisper/audio.%(ext)s` 171 | ], { 172 | encoding: 'utf-8', 173 | }).stdout); 174 | console.log(child_process.spawnSync('find', [number], { 175 | encoding: 'utf-8', 176 | }).stdout); 177 | // Run it through whisper 178 | console.log(child_process.spawnSync('python', [ 179 | 'transcribe_audio.py', `${number}/whisper/audio.mp3`, `${number}/whisper/transcription.json` 180 | ], { 181 | encoding: 'utf-8', 182 | }).stderr); 183 | // Now delete the audio file so we don't check it into the repo 184 | fs.unlinkSync(`${number}/whisper/audio.mp3`); 185 | // Load JSON from transcription.json 186 | const transcription = JSON.parse(fs.readFileSync(`${number}/whisper/transcription.json`)); 187 | let comment = ''; 188 | if (transcription.detected_language) { 189 | comment += `Language: ${transcription.detected_language}\n\n`; 190 | } 191 | if (transcription.transcription) { 192 | comment += 'Transcription: `' + transcription.transcription + '`\n\n'; 193 | } 194 | if (transcription.translation) { 195 | comment += 'Translation: `' + transcription.translation + '`\n\n'; 196 | } 197 | // Post the output as a comment 198 | github.rest.issues.createComment({ 199 | issue_number: context.issue.number, 200 | owner: context.repo.owner, 201 | repo: context.repo.repo, 202 | body: comment 203 | }); 204 | // Close the issue 205 | github.rest.issues.update({ 206 | issue_number: context.issue.number, 207 | owner: context.repo.owner, 208 | repo: context.repo.repo, 209 | state: 'closed' 210 | }); 211 | - name: Commit and push 212 | run: |- 213 | git config user.name "Automated" 214 | git config user.email "actions@users.noreply.github.com" 215 | git add -A 216 | git commit -m "Refs #${{ github.event.issue.number }}" || exit 0 217 | git pull --rebase 218 | git push 219 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------