Comments (6)
Notes were added, Github integration itself is postponed until next quarter. I close this issue for now.
from zally.
@Nagogus @mkulak Can you add your notes first? Based on this we can write documentation and see what needs to be implemented further.
from zally.
@fmueller first we need to implement authentication interface, so we can get github token. Currently token is hardcoded.
from zally.
Maybe it can be another task then?
from zally.
Currently GH integration works this way:
- We registered web-hook in test repo on actions "PR created" and "commit"
- There is special endpoint /github-hook in GithubController which is called by github on each PR/commit in test repo. (see docs)
- When callback from GH is received we set status of corresponding PR to
pending
. Then download content of swagger file from this PR and validate it. If there are MUST violations we set status of this PR tofailed
(which means that PR cannot be merged). Otherwise we set status tosuccess
.
Notes on current implementation:
- All requests are executed synchronously (set pending -> get content -> set success/failed)
- User need to setup webhook manually (Zappr does this automatically)
- In order to access file content we need to get token for this repo. For now it's hardcoded (same thing).
- Path to swagger file is hardcoded to
swagger/swagger.yaml
(perhaps there will be option to specify this path in Zally's frontend) - Status for PR is called "commit status" in GH parlance.
from zally.
@mkulak thanks for the notes. Also linking to #83, might be helpful.
from zally.
Related Issues (20)
- refactor: RFC 9457 obsoletes 7807, refer to it HOT 2
- Tooling: removes archived repositories HOT 1
- meta-information: do not copy the API-ID HOT 2
- Status codes publish to main HOT 1
- add more examples to query parameters HOT 1
- fix: using headers anchor (#783) HOT 1
- feat: add exception for partner IAM (#767)
- feat: add new rule to prefer single resources (#764) HOT 1
- feat: improve guidance on total counts (#731) HOT 1
- new rule: may use asynchronous processing HOT 1
- FunctionalNamingForHostnames only works with zalando domains HOT 1
- feat: improve response (code) guidance (#787, #762, #737)
- issue start web-ui on mac-os HOT 2
- Spring upgrade to address CVEs
- fix discrepancy between 109 and 111
- Fix typo in best-practices.adoc
- Add suggested changes from API guild discussion (POST usage) HOT 1
- Update security section about uid scope HOT 1
- Fix typo in introduction.adoc
- Add best practices section for rule 108
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from zally.