Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[full-ci] Service Accounts #6427

Merged
merged 11 commits into from
Aug 31, 2023
Merged

[full-ci] Service Accounts #6427

merged 11 commits into from
Aug 31, 2023

Conversation

kobergj
Copy link
Collaborator

@kobergj kobergj commented Jun 1, 2023

Introduces service-accounts

@update-docs
Copy link

update-docs bot commented Jun 1, 2023

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes.

@kobergj
Copy link
Collaborator Author

kobergj commented Jun 1, 2023

Introduces auth-service service

  • Provide a README.md for that service in the root folder of that service.
    • Use CamelCase for section headers.
  • For images and example files used in README.md:
    • Create a folder named md-sources on the same level where README.md is located. Put all the images and example files referenced by README.md into this folder.
    • Use absolute references like https://raw.githubusercontent.com/owncloud/ocis/master/services/<service-name>/md-sources/file to make the content accessible for both README.md and owncloud.dev
      bad <img src="https://github.com/owncloud/ocis/blob/master/services/graph/images/mermaid-graph.svg" width="500" />
      good <img src="https://raw.githubusercontent.com/owncloud/ocis/master/services/graph/images/mermaid-graph.svg" width="500" />
  • If new CLI command are introduced, that command must be described in readme.md.
  • If new global envvar is introduced, the name must start with OCIS_.
  • Add the service to the makefile in the ocis repo root.
  • Make the service startable for binary and individual startup:
    • For single binary add service to ocis/pkg/runtime
    • For individual startup add service to ocis/pkg/commands
  • Add the service to .drone.star to enable CI.
  • Inform doc team in an early stage to review the readme AND the environment variables created.
    • The description must reflect the behaviour AND usually has a positive code quality impact.
  • Create proper description strings for envvars - see other services for examples, especially when it comes to multiple values. This must include:
    • base description, set of available values, description of each value.
  • When suggestable commits are created for text changes and you agree, collect them to a batch and commit them. Do not forget to rebase locally to avoid overwriting the changes made.
  • If new envvars are introduced which serve the same purpose but in multiple services, an additional envvar must be added at the beginning of the list starting with OCIS_ (global envvar).
  • Ensure that a service has a debug port
  • If the new service introduces a new port:
  • Make sure to have a function FullDefaultConfig() in pkg/config/defaults/defaultconfig.go of your service. It is needed to create the documentation.

@ownclouders
Copy link
Contributor

ownclouders commented Jun 1, 2023

@kobergj kobergj force-pushed the ServiceAccounts branch 2 times, most recently from 59e19a3 to 27c6318 Compare June 13, 2023 09:39
@kobergj kobergj changed the title Service Accounts [full-ci] Service Accounts Jun 13, 2023
@sonarcloud
Copy link

sonarcloud bot commented Jun 13, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 2 Code Smells

0.8% 0.8% Coverage
10.3% 10.3% Duplication

@kobergj kobergj force-pushed the ServiceAccounts branch 7 times, most recently from 73104a7 to 71a49f0 Compare August 11, 2023 12:37
@kobergj kobergj force-pushed the ServiceAccounts branch 10 times, most recently from aa7831a to 746e3a9 Compare August 17, 2023 12:31
@sonarcloud
Copy link

sonarcloud bot commented Aug 31, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 6 Code Smells

29.1% 29.1% Coverage
17.5% 17.5% Duplication

@kobergj
Copy link
Collaborator Author

kobergj commented Aug 31, 2023

Just rebased to master - no extra review needed

@kobergj kobergj merged commit 22e590e into owncloud:master Aug 31, 2023
3 checks passed
@kobergj kobergj deleted the ServiceAccounts branch August 31, 2023 11:16
ownclouders pushed a commit that referenced this pull request Aug 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants