refactor(initial): [UDENG-5667] initalize and setup repository #1

hk21702 · 2024-12-17T15:56:07Z

Create basic project structure as well as adding initial basic GitHub Workflows.

The file structure is designed for three primary accessible components. The client-side, the server-side internet exposed service, and the server-side air gapped ingest service.

Project file structure
Ubuntu CLA workflow
PR title check
Jira workflow
README.md
CONTRIBUTING.md
Issue templates

UDENG-5667

.github/CODEOWNERS

.github/ISSUE_TEMPLATE/feature_request.yml

hk21702 · 2024-12-17T17:41:06Z

CONTRIBUTING.md

+- Only fix/add the functionality in question **OR** address wide-spread whitespace/style issues, not both.
+- Add unit or integration tests for fixed or changed functionality.
+- Address a single concern in the least number of changed lines as possible.
+- Include documentation in the repo or on our [docs site](https://github.com/ubuntu/Ubuntu-Insights/wiki).


Are we using the GitHub wiki for documentation?

hk21702 · 2024-12-17T17:41:38Z

CONTRIBUTING.md

+
+Contributions are made to this project via Issues and Pull Requests (PRs). A few general guidelines that cover both:
+
+- To report security vulnerabilities, please use the advisories page of the repository and not a public bug report. Please use [launchpad private bugs](https://bugs.launchpad.net/ubuntu/+source/Ubuntu-Insights/+filebug) which is monitored by our security team. On ubuntu machine, it’s best to use `ubuntu-bug Ubuntu Insights` to collect relevant information. FIXME: snap?


Unsure about this part.

hk21702 · 2024-12-17T18:00:45Z

.github/ISSUE_TEMPLATE/bug_report.yml

+      value: >
+        :warning: **Please do not report security vulnerabilities here**
+
+        Be careful with sensitive information and security vulnerabilities. In order to report bugs that could contain


Unsure about this part

hk21702 · 2024-12-17T18:01:00Z

.github/ISSUE_TEMPLATE/feature_request.yml

+      value: >
+        :warning: **Please do not report security vulnerabilities here**
+
+        Be careful with sensitive information and security vulnerabilities. In order to report bugs that could contain


Unsure for this part

The issue seems to be specific to the schema VSCode relies on, even though according to documentation, a string should be okay for the labels field.

sharder996

Looks fine for bootstrapping the repo. Only comment I have is the inconsistent file endings. Should standardize that.

CONTRIBUTING.md

hk21702 · 2024-12-19T18:09:38Z

Looks fine for bootstrapping the repo. Only comment I have is the inconsistent file endings. Should standardize that.

What do you mean by inconsistent file endings?

sharder996 · 2024-12-19T18:16:27Z

Looks fine for bootstrapping the repo. Only comment I have is the inconsistent file endings. Should standardize that.

What do you mean by inconsistent file endings?

i.e. Many of the .go files and a few other files in the diff show no newline and the bottom of the file. General best practice is to have newlines at the end of files. Normally, text editors should add this automatically, but if not it will create potentially annoying diffs in the future when the next contributor adds the newlines.

Sploder12

Looks pretty good, just some small things and questions from me

.github/workflows/sync-gh-jira.yaml

.github/ISSUE_TEMPLATE/bug_report.yml

.github/ISSUE_TEMPLATE/feature_request.yml

CONTRIBUTING.md

README.md

Co-authored-by: trevor-shoe <[email protected]>

sharder996 · 2024-12-20T15:03:50Z

@hk21702 There are still a bunch of file/line ending issues showing in the diff on github.

hk21702 · 2024-12-20T15:51:37Z

@hk21702 There are still a bunch of file/line ending issues showing in the diff on github.

I think GitHub just ignores the white space at the end of files in the diff. On my local clone, the new lines exist.

Sploder12 · 2024-12-20T16:53:32Z

I think GitHub just ignores the white space at the end of files in the diff. On my local clone, the new lines exist.

No, take cmd/exposed-server/daemon/daemon.go for example. The lack of new-line shows as the red thing.

.gitignore

.github/workflows/pr-title-check.yaml

.github/CODEOWNERS

sharder996

Thanks for humouring me and cleaning up the file endings!

Sploder12

LGTM!

CarlosNihelton · 2025-03-22T09:28:57Z

What about that commit @Patriot7865 ?

hk21702 added 3 commits December 16, 2024 14:17

Add initial gitignore for go project and vscode

e2ce220

Add initial README

bf22025

Initial boilerplate

41ee07f

hk21702 self-assigned this Dec 17, 2024

Fix readme links

27c46f8

hk21702 changed the title ~~[UDENG-5667] initalize and setup repository~~ refactor(initial): [UDENG-5667] initalize and setup repository Dec 17, 2024

hk21702 commented Dec 17, 2024

View reviewed changes

.github/CODEOWNERS Outdated Show resolved Hide resolved

hk21702 commented Dec 17, 2024

View reviewed changes

.github/ISSUE_TEMPLATE/feature_request.yml Outdated Show resolved Hide resolved

Update links and placeholder names

94223d9

hk21702 commented Dec 17, 2024

View reviewed changes

Fix placeholder names in issue templates

0031d0c

hk21702 commented Dec 17, 2024

View reviewed changes

hk21702 added 4 commits December 17, 2024 13:06

Set codeowners to be repository members

6180d0c

Remove shared actions

d73e945

Add PR title validation workflow

74e77e7

Modify issue template labels field to stop linters from complaining

7f78eb3

The issue seems to be specific to the schema VSCode relies on, even though according to documentation, a string should be okay for the labels field.

hk21702 force-pushed the UDENG-5666-initalize-and-setup-repository branch from b8d8ca2 to 7f78eb3 Compare December 17, 2024 18:24

hk21702 marked this pull request as ready for review December 19, 2024 15:42

hk21702 requested review from CarlosNihelton, Sploder12 and sharder996 December 19, 2024 17:25

sharder996 requested changes Dec 19, 2024

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

Remove flutter from contributer guidelines

bb3d2f3

Sploder12 requested changes Dec 19, 2024

View reviewed changes

hk21702 and others added 2 commits December 19, 2024 15:33

Add trailing newlines to go files for consistency

254b628

Update CONTRIBUTING.md

ad7f231

Co-authored-by: trevor-shoe <[email protected]>

Update contribution resources link in CONTRIBUTING.md

a5e85ba

hk21702 requested review from Sploder12 and sharder996 December 20, 2024 01:58

hk21702 mentioned this pull request Dec 20, 2024

feat(cmd/insights): Udeng 5696 initial client core cli #2

Merged

Add trailing whitespace

3c75126

sharder996 requested changes Dec 27, 2024

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

.github/workflows/pr-title-check.yaml Outdated Show resolved Hide resolved

.github/CODEOWNERS Outdated Show resolved Hide resolved

Add trailing whitespace to missed files

5e60543

hk21702 requested a review from sharder996 January 6, 2025 13:49

sharder996 approved these changes Jan 6, 2025

View reviewed changes

Sploder12 approved these changes Jan 6, 2025

View reviewed changes

CODEOWNERS syntax fix

0df57ec

hk21702 merged commit dd0f241 into ubuntu:main Jan 9, 2025


		Contributions are made to this project via Issues and Pull Requests (PRs). A few general guidelines that cover both:

		- To report security vulnerabilities, please use the advisories page of the repository and not a public bug report. Please use [launchpad private bugs](https://bugs.launchpad.net/ubuntu/+source/Ubuntu-Insights/+filebug) which is monitored by our security team. On ubuntu machine, it’s best to use `ubuntu-bug Ubuntu Insights` to collect relevant information. FIXME: snap?

refactor(initial): [UDENG-5667] initalize and setup repository #1

refactor(initial): [UDENG-5667] initalize and setup repository #1

Uh oh!

Conversation

hk21702 commented Dec 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hk21702 Dec 17, 2024

Choose a reason for hiding this comment

Uh oh!

hk21702 Dec 17, 2024

Choose a reason for hiding this comment

Uh oh!

hk21702 Dec 17, 2024

Choose a reason for hiding this comment

Uh oh!

hk21702 Dec 17, 2024

Choose a reason for hiding this comment

Uh oh!

sharder996 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hk21702 commented Dec 19, 2024

Uh oh!

sharder996 commented Dec 19, 2024

Uh oh!

Sploder12 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sharder996 commented Dec 20, 2024

Uh oh!

hk21702 commented Dec 20, 2024

Uh oh!

Sploder12 commented Dec 20, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sharder996 left a comment

Choose a reason for hiding this comment

Uh oh!

Sploder12 left a comment

Choose a reason for hiding this comment

Uh oh!

CarlosNihelton commented Mar 22, 2025

Uh oh!

Uh oh!

hk21702 commented Dec 17, 2024 •

edited

Loading