From 3f05ab04c116572f21ae58464a8a6a1fdd671f2e Mon Sep 17 00:00:00 2001 From: Bryan Wieger Date: Mon, 2 Dec 2024 11:21:02 -0800 Subject: [PATCH 1/7] checklist changes for going public [AXON-26] --- CONTRIBUTING.md | 31 +++++-------- README.md | 121 ++++++++++++++++++++++++++++++++++-------------- 2 files changed, 98 insertions(+), 54 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0d4da61e..cf87b00d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,27 +1,18 @@ -## Developer Information +# Contributing to [Project name] -### Remote Debugging +Thank you for considering a contribution to [Project name]! Pull requests, issues and comments are welcome. For pull requests, please: -For some tasks, it's important to be able to emulate [remote execution](https://code.visualstudio.com/docs/remote/remote-overview) of the VS Code - e.g. to reproduce or debug the behavior users observe when working in browser-based tools like Github Codespaces, or Salesforce Code Builder. +* Add tests for new features and bug fixes +* Follow the existing style +* Separate unrelated changes into multiple pull requests -VSCode provides some very helpful [documentation](https://code.visualstudio.com/api/advanced-topics/remote-extensions#debugging-extensions) on how to test and debug extensions for that environment. In short, one would need to set up Dev Containers execution as described [here](https://code.visualstudio.com/api/advanced-topics/remote-extensions#debugging-in-a-custom-development-container). +See the existing issues for things to start contributing. -To run `atlascode` in such a way, please follow the VSCode documentation: +For bigger changes, please make sure you start a discussion first by creating an issue and explaining the intended change. -- Install [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) VSCode Extension -- Run `npm install` like you normally would -- In VSCode, choose `Dev Containers: Rebuild and Reopen in Container` from the command pallette -- Wait for the VSCode to re-open in the container evnironment - you'll be able to see the difference in the header/search bar -- Proceed to run or debug the extension as usual - it will now be running as it would in remote execution +Atlassian requires contributors to sign a Contributor License Agreement, known as a CLA. This serves as a record stating that the contributor is entitled to contribute the code/documentation/translation to the project and is willing to have it used in distributions and derivative works (or is willing to transfer ownership). -The configuration for the Dev Container is located in [./.devcontainer/devcontainer.json](https://bitbucket.org/atlassianlabs/atlascode/src/main/.devcontainer/devcontainer.json). +Prior to accepting your contributions we ask that you please follow the appropriate link below to digitally sign the CLA. The Corporate CLA is for those who are contributing as a member of an organization and the individual CLA is for those contributing as an individual. -Note: for advanced use-cases, it is possible to run scripts in dev containers via [@devcontainers/cli](https://github.com/devcontainers/cli) - try `npx devcontainer --help` - -### Feature Flags - -This package uses FX3 - Atlassian's internal solution for running experiments and rolling out features. Using it requires an API key, which is not included in code as a matter of policy. - -If you are an Atlassian dev reading this - please look up the `atlascode` section [here](https://developer.atlassian.com/platform/frontend-feature-flags/resources/api-keys/), copy the value for the appropriate environment into `.env`, and rebuild the project. - -If you are an external contributor - please feel free to ignore the feature gate client initialization failure, the default configuration of the extension will work without it, as if all feature gated content were disabled. +* [CLA for corporate contributors](https://opensource.atlassian.com/corporate) +* [CLA for individuals](https://opensource.atlassian.com/individual) \ No newline at end of file diff --git a/README.md b/README.md index d0d5e533..32833411 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,17 @@ # Atlassian for VS Code -Atlassian for VS Code brings the functionality of Atlassian products to your favorite IDE! +[![Atlassian license](https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square)](LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](CONTRIBUTING.md) -This extension combines the power of Jira and Bitbucket to streamline the developer workflow within VS Code. +Stay in the flow by using Atlassian for VSCode to start work on a JIRA issue, raise and review PRs, and close out work! All directly from the IDE. -With Atlassian for VS Code you can create and view issues, start work on issues, create pull requests, do code reviews, start builds, get build statuses and more! -**Note:** 'Atlassian for VS Code' is published as an Atlassian Labs project. -Although you may find unique and highly useful functionality in the Atlassian Labs apps, Atlassian takes no responsibility for your use of these apps. +[**Download now**](https://marketplace.visualstudio.com/items?itemName=Atlassian.atlascode&ssr=false#overview) + + +## Usage + -## Getting Started +### Getting Started - Make sure you have VS Code version 1.40.0 or above - Download the extension from the marketplace @@ -20,7 +22,7 @@ For more information, see [Getting started with VS Code](https://confluence.atla **Note:** Jira Service Desk projects are not fully supported at this time. -## Features at a Glance +### Features at a Glance Here's a quick peek at a developer's workflow: @@ -44,22 +46,12 @@ Create that issue without breaking your stride: ...and lots more -## Everyone Has Issues... -Please refer to [our issue tracker for known issues](https://bitbucket.org/atlassianlabs/atlascode/issues) and please contribute if you encounter an issue yourself. - -**Note for Server/Data Center users:** The extension supports Jira and Bitbucket versions released in the last two years, per our [end of life policy](https://confluence.atlassian.com/x/ewAID). -You can find your instance's version in the footer of any Jira/Bitbucket page. - -### Questions? Comments? Kudos? +## Feedback Please use the in-app feedback form to tell us what you think! It's available from the 'Atlassian: Open Settings' and 'Atlassian: Open Welcome' pages available in the command palette. -## Contributors - -Pull requests, issues and comments welcome. - -Please read our [Code of Conduct](CODE_OF_CONDUCT.md). +## Installation Running and debugging the extension: @@ -73,22 +65,83 @@ Running and debugging the extension: ** If the extension development host is still running restart by clicking ⟲ in the debug toolbar. ** If you've already stopped the host just start debugging again. -For pull requests: -- Follow the existing style -- Separate unrelated changes into multiple pull requests -- Pull requests should target the `external-contributions` branch -Atlassian requires contributors to sign a Contributor License Agreement, -known as a CLA. This serves as a record stating that the contributor is -entitled to contribute the code/documentation/translation to the project -and is willing to have it used in distributions and derivative works -(or is willing to transfer ownership). +## Documentation + +### Feature Flags + +This package uses FX3 - Atlassian's internal solution for running experiments and rolling out features. Using it requires an API key, which is not included in code as a matter of policy. + +If you are an Atlassian dev reading this - please look up the `atlascode` section [here](https://developer.atlassian.com/platform/frontend-feature-flags/resources/api-keys/), copy the value for the appropriate environment into `.env`, and rebuild the project. + +If you are an external contributor - please feel free to ignore the feature gate client initialization failure, the default configuration of the extension will work without it, as if all feature gated content were disabled. + +### Remote Debugging + +For some tasks, it's important to be able to emulate [remote execution](https://code.visualstudio.com/docs/remote/remote-overview) of the VS Code - e.g. to reproduce or debug the behavior users observe when working in browser-based tools like Github Codespaces, or Salesforce Code Builder. + +VSCode provides some very helpful [documentation](https://code.visualstudio.com/api/advanced-topics/remote-extensions#debugging-extensions) on how to test and debug extensions for that environment. In short, one would need to set up Dev Containers execution as described [here](https://code.visualstudio.com/api/advanced-topics/remote-extensions#debugging-in-a-custom-development-container). + +To run `atlascode` in such a way, please follow the VSCode documentation: + +- Install [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) VSCode Extension +- Run `npm install` like you normally would +- In VSCode, choose `Dev Containers: Rebuild and Reopen in Container` from the command pallette +- Wait for the VSCode to re-open in the container evnironment - you'll be able to see the difference in the header/search bar +- Proceed to run or debug the extension as usual - it will now be running as it would in remote execution + +The configuration for the Dev Container is located in [./.devcontainer/devcontainer.json](https://bitbucket.org/atlassianlabs/atlascode/src/main/.devcontainer/devcontainer.json). + +Note: for advanced use-cases, it is possible to run scripts in dev containers via [@devcontainers/cli](https://github.com/devcontainers/cli) - try `npx devcontainer --help` + + + +## Tests + +``` +npm run test +``` + +## Contributions + +Contributions to Atlassian for VS Code are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details. + +# Issues + +We moved from Bitbucket to Github. + +To open a new issues, please see Github + +To see old issues, please first look at Github then at [Bitbucket](https://bitbucket.org/atlassianlabs/atlascode/issues) + +**Note for Server/Data Center users:** The extension supports Jira and Bitbucket versions released in the last two years, per our [end of life policy](https://confluence.atlassian.com/x/ewAID). +You can find your instance's version in the footer of any Jira/Bitbucket page. + +## License + +Copyright (c) [YYYY] Atlassian US., Inc. +Apache 2.0 licensed, see [LICENSE](LICENSE) file. + +
+ +[![With ❤️ from Atlassian](https://raw.githubusercontent.com/atlassian-internal/oss-assets/master/banner-with-thanks-light.png)](https://www.atlassian.com) + + + +# Atlassian for VS Code + +Atlassian for VS Code brings the functionality of Atlassian products to your favorite IDE! + +This extension combines the power of Jira and Bitbucket to streamline the developer workflow within VS Code. + +With Atlassian for VS Code you can create and view issues, start work on issues, create pull requests, do code reviews, start builds, get build statuses and more! + +**Note:** 'Atlassian for VS Code' is published as an Atlassian Labs project. +Although you may find unique and highly useful functionality in the Atlassian Labs apps, Atlassian takes no responsibility for your use of these apps. + + + + -Prior to accepting your contributions we ask that you please follow the appropriate -link below to digitally sign the CLA. The Corporate CLA is for those who are -contributing as a member of an organization and the individual CLA is for -those contributing as an individual. -- [CLA for corporate contributors](https://na2.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=e1c17c66-ca4d-4aab-a953-2c231af4a20b) -- [CLA for individuals](https://na2.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=3f94fbdc-2fbe-46ac-b14c-5d152700ae5d) From c9a28a89670dabadf7e490debc495eb6df486077 Mon Sep 17 00:00:00 2001 From: Bryan Wieger Date: Mon, 2 Dec 2024 11:23:28 -0800 Subject: [PATCH 2/7] Codeowners --- CODEOWNERS | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 CODEOWNERS diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 00000000..310ec6e9 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,67 @@ +# This is a comment. +# Each line is a file pattern followed by one or more owners. + +# These owners will be the default owners for everything in +# the repo. Unless a later match takes precedence, +# @global-owner1 and @global-owner2 will be requested for +# review when someone opens a pull request. +* @bwieger-atlassian-com @sdzh-atlassian @cabella-dot + +# Order is important; the last matching pattern takes the most +# precedence. When someone opens a pull request that only +# modifies JS files, only @js-owner and not the global +# owner(s) will be requested for a review. +# EX: *.js @js-owner #This is an inline comment. + +# You can also use email addresses if you prefer. They'll be +# used to look up users just like we do for commit author +# emails. +# EX: *.go docs@example.com + +# Teams can be specified as code owners as well. Teams should +# be identified in the format @org/team-name. Teams must have +# explicit write access to the repository. In this example, +# the octocats team in the octo-org organization owns all .txt files. +# EX: *.txt @octo-org/octocats + +# In this example, @doctocat owns any files in the build/logs +# directory at the root of the repository and any of its +# subdirectories. +# EX: /build/logs/ @doctocat + +# The `docs/*` pattern will match files like +# `docs/getting-started.md` but not further nested files like +# `docs/build-app/troubleshooting.md`. +# EX: docs/* docs@example.com + +# In this example, @octocat owns any file in an apps directory +# anywhere in your repository. +# EX: apps/ @octocat + +# In this example, @doctocat owns any file in the `/docs` +# directory in the root of your repository and any of its +# subdirectories. +# EX: /docs/ @doctocat + +# In this example, any change inside the `/scripts` directory +# will require approval from @doctocat or @octocat. +# EX: /scripts/ @doctocat @octocat + +# In this example, @octocat owns any file in a `/logs` directory such as +# `/build/logs`, `/scripts/logs`, and `/deeply/nested/logs`. Any changes +# in a `/logs` directory will require approval from @octocat. +# EX: **/logs @octocat + +# In this example, @octocat owns any file in the `/apps` +# directory in the root of your repository except for the `/apps/github` +# subdirectory, as its owners are left empty. Without an owner, changes +# to `apps/github` can be made with the approval of any user who has +# write access to the repository. +# EX: /apps/ @octocat +# EX: /apps/github + +# In this example, @octocat owns any file in the `/apps` +# directory in the root of your repository except for the `/apps/github` +# subdirectory, as this subdirectory has its own owner @doctocat +# EX: /apps/ @octocat +# EX: /apps/github @doctocat \ No newline at end of file From 9a87d11aa29da054f5ac122910511c1327cb2ee8 Mon Sep 17 00:00:00 2001 From: Bryan Wieger Date: Mon, 2 Dec 2024 11:51:21 -0800 Subject: [PATCH 3/7] [AXON-26] home page --- CONTRIBUTING.md | 4 +-- HOMEPAGE.md | 95 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 +- package.json | 2 +- 4 files changed, 99 insertions(+), 4 deletions(-) create mode 100644 HOMEPAGE.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cf87b00d..ecb02f61 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -# Contributing to [Project name] +# Contributing to Atlassian for VS Code -Thank you for considering a contribution to [Project name]! Pull requests, issues and comments are welcome. For pull requests, please: +Thank you for considering a contribution to Atlassian for VS Code! Pull requests, issues and comments are welcome. For pull requests, please: * Add tests for new features and bug fixes * Follow the existing style diff --git a/HOMEPAGE.md b/HOMEPAGE.md new file mode 100644 index 00000000..af4949b9 --- /dev/null +++ b/HOMEPAGE.md @@ -0,0 +1,95 @@ +# Atlassian for VS Code + +Atlassian for VS Code brings the functionality of Atlassian products to your favorite IDE! + +This extension combines the power of Jira and Bitbucket to streamline the developer workflow within VS Code. + +With Atlassian for VS Code you can create and view issues, start work on issues, create pull requests, do code reviews, start builds, get build statuses and more! + +**Note:** 'Atlassian for VS Code' is published as an Atlassian Labs project. +Although you may find unique and highly useful functionality in the Atlassian Labs apps, Atlassian takes no responsibility for your use of these apps. + +## Getting Started + +- Make sure you have VS Code version 1.40.0 or above +- Download the extension from the marketplace +- Authenticate with Jira and/or Bitbucket from the 'Atlassian: Open Settings' page available in the command palette +- From the command palette, type 'Atlassian:' to see all of the extensions available commands + +For more information, see [Getting started with VS Code](https://confluence.atlassian.com/display/BITBUCKET/Getting+started+with+VS+Code) and the related content. + +**Note:** Jira Service Desk projects are not fully supported at this time. + +## Features at a Glance + +Here's a quick peek at a developer's workflow: + +![dev workflow](https://bitbucket.org/atlassianlabs/atlascode/raw/main/.readme/dev-workflow.gif) + +Reviewing with Bitbucket pull request features is a snap: + +![review pr](https://bitbucket.org/atlassianlabs/atlascode/raw/main/.readme/review-pr.gif) + +Got a burning issue you'd like to work on? + +![start work](https://bitbucket.org/atlassianlabs/atlascode/raw/main/.readme/issue-start-work.gif) + +Kick off your builds: + +![builds](https://bitbucket.org/atlassianlabs/atlascode/raw/main/.readme/start-pipeline.gif) + +Create that issue without breaking your stride: + +![issue from todo](https://bitbucket.org/atlassianlabs/atlascode/raw/main/.readme/create-from-code-lens.gif) + +...and lots more + +## Everyone Has Issues... + +Please refer to [our issue tracker for known issues](https://bitbucket.org/atlassianlabs/atlascode/issues) and please contribute if you encounter an issue yourself. + +**Note for Server/Data Center users:** The extension supports Jira and Bitbucket versions released in the last two years, per our [end of life policy](https://confluence.atlassian.com/x/ewAID). +You can find your instance's version in the footer of any Jira/Bitbucket page. + +### Questions? Comments? Kudos? + +Please use the in-app feedback form to tell us what you think! It's available from the 'Atlassian: Open Settings' and 'Atlassian: Open Welcome' pages available in the command palette. + +## Contributors + +Pull requests, issues and comments welcome. + +Please read our [Code of Conduct](CODE_OF_CONDUCT.md). + +Running and debugging the extension: + +- Atlassian for VS Code is a node project, as such you'll need to run `npm install` before building. +- To debug the extension from within VS Code you'll need a `launch.json`. + ** An example `launch.json` that will be suitable for most users is included as `.vscode/launch.json.example`. + ** To use the example file simply copy it to `launch.json`. +- Once you have a `launch.json` file select "Debug and Run" from the Activity Bar and click "Start Debugging". + \*\* After the extension builds VS Code will launch a new instance of itself (the Extension Development Host) running the extension. +- When you want to test your code changes + ** If the extension development host is still running restart by clicking ⟲ in the debug toolbar. + ** If you've already stopped the host just start debugging again. + +For pull requests: + +- Follow the existing style +- Separate unrelated changes into multiple pull requests +- Pull requests should target the `external-contributions` branch + +Atlassian requires contributors to sign a Contributor License Agreement, +known as a CLA. This serves as a record stating that the contributor is +entitled to contribute the code/documentation/translation to the project +and is willing to have it used in distributions and derivative works +(or is willing to transfer ownership). + +Prior to accepting your contributions we ask that you please follow the appropriate +link below to digitally sign the CLA. The Corporate CLA is for those who are +contributing as a member of an organization and the individual CLA is for +those contributing as an individual. + +- [CLA for corporate contributors](https://na2.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=e1c17c66-ca4d-4aab-a953-2c231af4a20b) +- [CLA for individuals](https://na2.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=3f94fbdc-2fbe-46ac-b14c-5d152700ae5d) + diff --git a/README.md b/README.md index 32833411..8129e88d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Atlassian for VS Code -[![Atlassian license](https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square)](LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](CONTRIBUTING.md) +[![Atlassian license](https://img.shields.io/badge/license-MIT%20-blue.svg?style=flat-square)](LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](CONTRIBUTING.md) Stay in the flow by using Atlassian for VSCode to start work on a JIRA issue, raise and review PRs, and close out work! All directly from the IDE. diff --git a/package.json b/package.json index 572ec0b3..c5234a27 100644 --- a/package.json +++ b/package.json @@ -13,7 +13,7 @@ "version": "0.0.0", "publisher": "atlassian", "license": "SEE LICENSE IN LICENSE", - "homepage": "https://bitbucket.org/atlassianlabs/atlascode/src/main/README.md", + "homepage": "https://github.com/atlassian/atlascode/blob/main/HOMEPAGE.md", "repository": { "type": "git", "url": "https://bitbucket.org/atlassianlabs/atlascode.git" From c4476d2f0200f38880ea6c047a214b47c67fcfa0 Mon Sep 17 00:00:00 2001 From: Bryan Wieger Date: Mon, 2 Dec 2024 11:56:47 -0800 Subject: [PATCH 4/7] [AXON-26] readme --- README.md | 24 ++---------------------- 1 file changed, 2 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 8129e88d..f055eba8 100644 --- a/README.md +++ b/README.md @@ -120,28 +120,8 @@ You can find your instance's version in the footer of any Jira/Bitbucket page. ## License -Copyright (c) [YYYY] Atlassian US., Inc. -Apache 2.0 licensed, see [LICENSE](LICENSE) file. +See [LICENSE](LICENSE) file
-[![With ❤️ from Atlassian](https://raw.githubusercontent.com/atlassian-internal/oss-assets/master/banner-with-thanks-light.png)](https://www.atlassian.com) - - - -# Atlassian for VS Code - -Atlassian for VS Code brings the functionality of Atlassian products to your favorite IDE! - -This extension combines the power of Jira and Bitbucket to streamline the developer workflow within VS Code. - -With Atlassian for VS Code you can create and view issues, start work on issues, create pull requests, do code reviews, start builds, get build statuses and more! - -**Note:** 'Atlassian for VS Code' is published as an Atlassian Labs project. -Although you may find unique and highly useful functionality in the Atlassian Labs apps, Atlassian takes no responsibility for your use of these apps. - - - - - - +[![With thanks from Atlassian](https://raw.githubusercontent.com/atlassian-internal/oss-assets/master/banner-with-thanks-light.png)](https://www.atlassian.com) From 0db8f392b42a1e0247f21de1c3f2625ad96289b1 Mon Sep 17 00:00:00 2001 From: Bryan Wieger Date: Mon, 2 Dec 2024 12:03:06 -0800 Subject: [PATCH 5/7] touch --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index f055eba8..6bcd21a6 100644 --- a/README.md +++ b/README.md @@ -125,3 +125,4 @@ See [LICENSE](LICENSE) file
[![With thanks from Atlassian](https://raw.githubusercontent.com/atlassian-internal/oss-assets/master/banner-with-thanks-light.png)](https://www.atlassian.com) + From 7e12d737dfca5a4fb79d5cc32edf73d0d8e4e985 Mon Sep 17 00:00:00 2001 From: Bryan Wieger Date: Mon, 2 Dec 2024 12:03:26 -0800 Subject: [PATCH 6/7] touch --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 6bcd21a6..f055eba8 100644 --- a/README.md +++ b/README.md @@ -125,4 +125,3 @@ See [LICENSE](LICENSE) file
[![With thanks from Atlassian](https://raw.githubusercontent.com/atlassian-internal/oss-assets/master/banner-with-thanks-light.png)](https://www.atlassian.com) - From 5ad4f2ff2e7ea68b633eadd90ccf1b2ffd6dfe5c Mon Sep 17 00:00:00 2001 From: Bryan Wieger Date: Mon, 2 Dec 2024 12:10:25 -0800 Subject: [PATCH 7/7] fix build targeting --- .github/workflows/build.yaml | 2 +- .github/workflows/release.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index ce5131f5..00b59d14 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -3,7 +3,7 @@ name: Build on: push: branches: - - '*' + - '**' jobs: build: diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 2292153b..9efffb08 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -3,7 +3,7 @@ name: Release on: push: tags: - - '*' + - '**' jobs: release: