Skip to content

Commit

Permalink
Merge branch 'master' into compodoc
Browse files Browse the repository at this point in the history
  • Loading branch information
jeefy authored May 11, 2019
2 parents c8e5072 + 5c8251e commit a332aad
Show file tree
Hide file tree
Showing 37 changed files with 743 additions and 1,308 deletions.
13 changes: 13 additions & 0 deletions .prettierrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
printWidth: 100
tabWidth: 2
useTabs: false
semi: true
singleQuote: true
trailingComma: 'all'
bracketSpacing: true
jsxBracketSameLine: true
arrowParens: 'avoid'
requirePragma: false
insertPragma: false
proseWrap: 'preserve'
31 changes: 18 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Release Notes

A lightweight release notes UI to help users keep track of the ever-changing codebase for Kubernetes.

## Development

Local requirements:
* ng-cli (@angular/cli)
* golang > 1.11 (to run the release-notes JSON tool)
* `go get k8s.io/release/cmd/release-notes`

- ng-cli (@angular/cli)
- golang > 1.11 (to run the release-notes JSON tool)
- `go get k8s.io/release/cmd/release-notes`

(to generate any additional notes for development)

Expand Down Expand Up @@ -38,26 +40,29 @@ Once complete, you can view it by going to `localhost` in your browser:
## FAQ

### Why?

Release notes can and should be better. Empowering end-users to view what they need, while also being able to highlight **important** info, is our goal.

It does involve some engineering effort, but this is a case where technology can help us and we should not incur much technical debt.

Also it's cool.

### Can this be used for other projects?

With some changes, this could become a generic tool. There are no immediate plans to do that though.

## Roadmap
## Roadmap

Some of these may be blocked by external dependencies (such as GitHub labels not existing)

In no particular order:

* Improved filtering and have selectable or/and logic.
* Generate **Security Content** from PRs with `area/security`.
* Generate **Known Issues** from issues with release milestones attached.
* Generate **New Features** from PRs with `area/feature` label, though no idea how to differentiate what's "new" yet.
* Create structure for **Urgent Upgrade Notes** that can be manually added to a generated release JSON file.
* Create labels and write handling for a potential `area/dependency` label to help generate **External Dependencies**.
* Add support for viewing "alpha" and "beta" release notes, though disabled by default.
* Highlight labels that are selected.
* Rewrite relationship between "options" and "notes"
- Improved filtering and have selectable or/and logic.
- Generate **Security Content** from PRs with `area/security`.
- Generate **Known Issues** from issues with release milestones attached.
- Generate **New Features** from PRs with `area/feature` label, though no idea how to differentiate what's "new" yet.
- Create structure for **Urgent Upgrade Notes** that can be manually added to a generated release JSON file.
- Create labels and write handling for a potential `area/dependency` label to help generate **External Dependencies**.
- Add support for viewing "alpha" and "beta" release notes, though disabled by default.
- Highlight labels that are selected.
- Rewrite relationship between "options" and "notes"
33 changes: 8 additions & 25 deletions angular.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,8 @@
"main": "src/main.ts",
"polyfills": "src/polyfills.ts",
"tsConfig": "src/tsconfig.app.json",
"assets": [
"src/favicon.png",
"src/assets"
],
"styles": [
"src/styles.css"
],
"assets": ["src/favicon.png", "src/assets"],
"styles": ["src/styles.css"],
"scripts": [],
"es5BrowserSupport": true
},
Expand Down Expand Up @@ -79,26 +74,16 @@
"polyfills": "src/polyfills.ts",
"tsConfig": "src/tsconfig.spec.json",
"karmaConfig": "src/karma.conf.js",
"styles": [
"src/styles.css"
],
"styles": ["src/styles.css"],
"scripts": [],
"assets": [
"src/favicon.ico",
"src/assets"
]
"assets": ["src/favicon.ico", "src/assets"]
}
},
"lint": {
"builder": "@angular-devkit/build-angular:tslint",
"options": {
"tsConfig": [
"src/tsconfig.app.json",
"src/tsconfig.spec.json"
],
"exclude": [
"**/node_modules/**"
]
"tsConfig": ["src/tsconfig.app.json", "src/tsconfig.spec.json"],
"exclude": ["**/node_modules/**"]
}
}
}
Expand All @@ -124,13 +109,11 @@
"builder": "@angular-devkit/build-angular:tslint",
"options": {
"tsConfig": "e2e/tsconfig.e2e.json",
"exclude": [
"**/node_modules/**"
]
"exclude": ["**/node_modules/**"]
}
}
}
}
},
"defaultProject": "relnotes"
}
}
13 changes: 9 additions & 4 deletions e2e/src/app.e2e-spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,14 @@ describe('workspace-project App', () => {

afterEach(async () => {
// Assert that there are no errors emitted from the browser
const logs = await browser.manage().logs().get(logging.Type.BROWSER);
expect(logs).not.toContain(jasmine.objectContaining({
level: logging.Level.SEVERE,
} as logging.Entry));
const logs = await browser
.manage()
.logs()
.get(logging.Type.BROWSER);
expect(logs).not.toContain(
jasmine.objectContaining({
level: logging.Level.SEVERE,
} as logging.Entry),
);
});
});
8 changes: 2 additions & 6 deletions e2e/tsconfig.e2e.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@
"outDir": "../out-tsc/app",
"module": "commonjs",
"target": "es5",
"types": [
"jasmine",
"jasminewd2",
"node"
]
"types": ["jasmine", "jasminewd2", "node"]
}
}
}
Loading

0 comments on commit a332aad

Please sign in to comment.