Skip to content

Commit

Permalink
Release 0.1.0 (#202)
Browse files Browse the repository at this point in the history
  • Loading branch information
abhidnya13 authored Mar 29, 2021
1 parent a01d22e commit aafad39
Show file tree
Hide file tree
Showing 150 changed files with 14,312 additions and 4,523 deletions.
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
name: Bug report
about: Please do NOT file bugs without filling in this form.
title: '[Bug] '
labels: ''
assignees: ''

---

**Which version of MSAL Go are you using?**
Note that to get help, you need to run the latest version.
<!-- E.g. Microsoft Authentication Library for Go 1.0.0-preview -->

**Where is the issue?**
* Public client
* [ ] Device code flow
* [ ] Username/Password (ROPC grant)
* [ ] Authorization code flow
* Confidential client
* [ ] Authorization code flow
* [ ] Client credentials:
* [ ] client secret
* [ ] client certificate
* Token cache serialization
* [ ] In-memory cache
* Other (please describe)

**Is this a new or an existing app?**
<!-- Ex:
a. The app is in production and I have upgraded to a new version of Microsoft Authentication Library for Go.
b. The app is in production and I haven't upgraded Microsoft Authentication Library for Go, but started seeing this issue.
c. This is a new app or an experiment.
-->

**What version of Go are you using (`go version`)?**

<pre>
$ go version
</pre>

**What operating system and processor architecture are you using (`go env`)?**

<details><summary><code>go env</code> Output</summary><br><pre>
$ go env

</pre></details>

**Repro**

<code>var your = (code) => here;</code>

**Expected behavior**
A clear and concise description of what you expected to happen (or code).

**Actual behavior**
A clear and concise description of what happens, e.g. an exception is thrown, UI freezes.

**Possible solution**
<!--- Only if you have suggestions on a fix for the bug. -->

**Additional context / logs / screenshots**
Add any other context about the problem here, such as logs and screenshots.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Documentation
about: Suggest a change to the documentation.
title: '[Documentation] '
labels: documentation
assignees: ''

---

### Documentation related to component
<!-- Type name of component here (e.g. "Contribute", or "Logging" ) -->

### Please check all that apply

- [ ] typo
- [ ] documentation doesn't exist
- [ ] documentation needs clarification
- [ ] error(s) in the example
- [ ] needs an example

### Description of the issue
<!-- Descrbe the issue in detail here -->
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project.
title: "[Feature Request] "
labels: enhancement, Feature Request
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...].

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
49 changes: 49 additions & 0 deletions .github/workflows/go.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Go

on:
push:
branches: [dev]
pull_request:
branches: [dev]
# This guards against unknown PR until a community member vet it and label it.
types: [ labeled ]


jobs:
build:
name: Build

runs-on: ubuntu-latest

strategy:
matrix:
go: ["1.15", "1.14", "1.13"]

steps:
- name: Set up Go 1.x
uses: actions/setup-go@v2
with:
go-version: ${{ matrix.go }}
id: go

- name: Check out code into the Go module directory
uses: actions/checkout@v2

- name: Get dependencies
run: go get -v -t -d ./...

# designed to only run on linux
- name: Format Check
run: if [ $(gofmt -l -s . | wc -l) -ne 0 ]; then echo "fmt failed"; exit 1; fi

- name: Build
run: go build ./apps/...

- name: Unit Tests
run: go test -race -short ./apps/cache/... ./apps/confidential/... ./apps/public/... ./apps/internal/...

- name: Integration Tests
run: go test -race ./apps/tests/integration/...
env :
clientId: ${{ secrets.LAB_APP_CLIENT_ID }}
clientSecret: ${{ secrets.LAB_APP_CLIENT_SECRET }}
30 changes: 30 additions & 0 deletions .github/workflows/golangci-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: golangci-lint
on:
push:
tags:
- v*
branches:
- master
- main
- dev
pull_request:
# This guards against unknown PR until a community member vet it and label it.
types: [ labeled ]

jobs:
golangci:
name: lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: golangci-lint
uses: golangci/golangci-lint-action@v2
with:
# Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
version: v1.32

# Optional: golangci-lint command line arguments.
# args: --issues-exit-code=0

# Optional: show only new issues if it's a pull request. The default value is `false`.
only-new-issues: true
10 changes: 9 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@
*.dll
*.so
*.dylib
*.golangci.yml
*.swp
*.pprof

# OSX specific os files
*.DS_Store

# Test binary, build with `go test -c`
*.test
Expand All @@ -13,4 +19,6 @@

pkg/
github.com/
golang.org/
golang.org/
.vscode/
.idea/
12 changes: 12 additions & 0 deletions .golangci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
linters:
# enabled in addition to default
enable:
- gosec

issues:
# Excluding configuration per-path, per-linter, per-text and per-source
exclude-rules:
# Exclude some linters from running on tests files.
- path: _test\.go
linters:
- gosec
117 changes: 117 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
# Microsoft Authentication Library for Go welcomes new contributors

This document will guide you through the process.

## Contributor License agreement

Please visit [https://cla.microsoft.com/](https://cla.microsoft.com/) and sign the Contributor License
Agreement. You only need to do that once. We can not look at your code until you've submitted this request.

## FORK

Fork the project [on GitHub](https://github.com/AzureAD/microsoft-authentication-library-for-go) and check out
your copy.

Example for MSAL Go:

```
$ git clone [email protected]:username/microsoft-authentication-library-for-go.git
$ cd microsoft-authentication-library-for-go
$ git remote add upstream [email protected]:AzureAD/microsoft-authentication-library-for-go.git
```

## Setup, Building and Testing

Please see the [Build & Run](https://github.com/AzureAD/microsoft-authentication-library-for-go/wiki/build-and-test) wiki page.

## Decide on which branch to create

**Bug fixes for the current stable version need to go to 'master' branch.**

If you need to contribute to a different branch, please contact us first (open an issue).

All details after this point is standard - make sure your commits have nice messages, and prefer rebase to merge.

In case of doubt, please open an issue in the [issue tracker](https://github.com/AzureAD/microsoft-authentication-library-for-go/issues).

Especially do so if you plan to work on a major change in functionality. Nothing is more
frustrating than seeing your hard work go to waste because your vision
does not align with our goals for the SDK.

## Branch

Okay, so you have decided on the proper branch. Create a feature branch
and start hacking:

```
$ git checkout -b my-feature-branch
```

## Commit

Make sure git knows your name and email address:

```
$ git config --global user.name "J. Random User"
$ git config --global user.email "[email protected]"
```

Writing good commit logs is important. A commit log should describe what
changed and why. Follow these guidelines when writing one:

1. The first line should be 50 characters or less and contain a short
description of the change prefixed with the name of the changed
subsystem (e.g. "net: add localAddress and localPort to Socket").
2. Keep the second line blank.
3. Wrap all other lines at 72 columns.

A good commit log looks like this:

```
fix: explaining the commit in one line
Body of commit message is a few lines of text, explaining things
in more detail, possibly giving some background about the issue
being fixed, etc etc.
The body of the commit message can be several paragraphs, and
please do proper word-wrap and keep columns shorter than about
72 characters or so. That way `git log` will show things
nicely even when it is indented.
```

The header line should be meaningful; it is what other people see when they
run `git shortlog` or `git log --oneline`.

Check the output of `git log --oneline files_that_you_changed` to find out
what directories your changes touch.

### Rebase

Use `git rebase` (not `git merge`) to sync your work from time to time.

```
$ git fetch upstream
$ git rebase upstream/v0.1 # or upstream/master
```

### Tests

It's all standard stuff, but please note that you won't be able to run integration tests locally because they connect to a KeyVault to fetch some test users and passwords. The CI will run them for you.

### Push

```
$ git push origin my-feature-branch
```

Go to `https://github.com/username/microsoft-authentication-library-for-go` and select your feature branch. Click
the 'Pull Request' button and fill out the form.

Pull requests are usually reviewed within a few days. If there are comments
to address, apply your changes in a separate commit and push that to your
feature branch. Post a comment in the pull request afterwards; GitHub does
not send out notifications when you add commits.

[on GitHub]: https://github.com/AzureAD/microsoft-authentication-library-for-go
[issue tracker]: https://github.com/AzureAD/microsoft-authentication-library-for-go/issues
Loading

0 comments on commit aafad39

Please sign in to comment.