Skip to content

Commit

Permalink
Merge pull request nus-cs2103-AY2223S1#82 from jasonqiu212/75-update-dg
Browse files Browse the repository at this point in the history
Add implementation of `find_task` command in DG
  • Loading branch information
peppapighs authored Oct 21, 2022
2 parents 1bcefc2 + 6baa295 commit 5348af6
Show file tree
Hide file tree
Showing 13 changed files with 390 additions and 347 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Swift+

[![codecov](https://codecov.io/gh/AY2223S1-CS2103T-T12-2/tp/branch/master/graph/badge.svg?token=A2FU6P932B)](https://app.codecov.io/gh/AY2223S1-CS2103T-T12-2/tp)
[![CI Status](https://github.com/AY2223S1-CS2103T-T12-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2223S1-CS2103T-T12-2/tp/actions)

# Swift+

![Ui](docs/images/Ui.png)

### Manage your Team like never before
Expand All @@ -27,3 +27,4 @@
## Acknowledgements

- This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
- Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)
20 changes: 10 additions & 10 deletions docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ You can reach us at the email `[email protected]`
[[github](https://github.com/jasonqiu212)]
[[portfolio](team/jasonqiu212.md)]

* Role: Team lead
* Responsibilities: UI
- Role: Team lead
- Responsibilities: UI

### Pontakorn Prasertsuk

Expand All @@ -26,17 +26,17 @@ You can reach us at the email `[email protected]`
[[github](http://github.com/peppapighs)]
[[portfolio](team/peppapighs.md)]

* Role: Code Quality
* Responsibilities: UI
- Role: Code Quality
- Responsibilities: UI

### Shenyi Cui

<img src="images/shenyicui.png" width="200px">

[[github](http://github.com/shenyicui)] [[portfolio](team/shenyicui.md)]

* Role: Deliverables
* Responsibilities: Issues
- Role: Deliverables
- Responsibilities: Issues

### Muthukrishnan Santosh

Expand All @@ -45,8 +45,8 @@ You can reach us at the email `[email protected]`
[[github](http://github.com/santosh3007)]
[[portfolio](team/santosh3007.md)]

* Role: Documentation
* Responsibilities: Manage Non-Functional Requirements
- Role: Documentation
- Responsibilities: Manage Non-Functional Requirements

### Chin Yun Ru

Expand All @@ -55,5 +55,5 @@ You can reach us at the email `[email protected]`
[[github](http://github.com/yunruu)]
[[portfolio](team/yunruu.md)]

* Role: Integration
* Responsibilities: Glossary
- Role: Integration
- Responsibilities: Glossary
49 changes: 24 additions & 25 deletions docs/DevOps.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,36 +3,34 @@ layout: page
title: DevOps guide
---

* Table of Contents
- Table of Contents
{:toc}

--------------------------------------------------------------------------------------------------------------------
---

## Build automation

This project uses Gradle for **build automation and dependency management**. **You are recommended to read [this Gradle Tutorial from the se-edu/guides](https://se-education.org/guides/tutorials/gradle.html)**.


Given below are how to use Gradle for some important project tasks.


* **`clean`**: Deletes the files created during the previous build tasks (e.g. files in the `build` folder).<br>
- **`clean`**: Deletes the files created during the previous build tasks (e.g. files in the `build` folder).<br>
e.g. `./gradlew clean`

* **`shadowJar`**: Uses the ShadowJar plugin to creat a fat JAR file in the `build/lib` folder, *if the current file is outdated*.<br>
- **`shadowJar`**: Uses the ShadowJar plugin to creat a fat JAR file in the `build/lib` folder, _if the current file is outdated_.<br>
e.g. `./gradlew shadowJar`.

* **`run`**: Builds and runs the application.<br>
- **`run`**: Builds and runs the application.<br>
**`runShadow`**: Builds the application as a fat JAR, and then runs it.

* **`checkstyleMain`**: Runs the code style check for the main code base.<br>
- **`checkstyleMain`**: Runs the code style check for the main code base.<br>
**`checkstyleTest`**: Runs the code style check for the test code base.

* **`test`**: Runs all tests.<
* `./gradlew test` — Runs all tests
* `./gradlew clean test` — Cleans the project and runs tests
- **`test`**: Runs all tests.<
- `./gradlew test` — Runs all tests
- `./gradlew clean test` — Cleans the project and runs tests

--------------------------------------------------------------------------------------------------------------------
---

## Continuous integration (CI)

Expand All @@ -43,9 +41,9 @@ This project uses GitHub Actions for CI. The project comes with the necessary Gi
As part of CI, this project uses Codecov to generate coverage reports. When CI runs, it will generate code coverage data (based on the tests run by CI) and upload that data to the CodeCov website, which in turn can provide you more info about the coverage of your testes. Here are the steps to set up CodeCov for a fork of this repository.

1. Sign up with Codecov using your GitHub account [here](https://codecov.io/signup).
1. Once you are inside Codecov web app, add your org (that contains the fork) to CodeCov.
1. Wait for the next run of CI in your fork (or push a dummy commit to it to trigger CI) to confirm CI is able to upload generated coverage data to CodeCov. If CodeCov is not set up correctly, the CI run will fail with an error message that mentions CodeCov.
1. Get the Markdown code for the Codecov badge provided in `Settings > Badges` and update the `docs/index.md` of your repo with it so that the badge [![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3) in that page reflects the coverage of your project.
2. Once you are inside Codecov web app, add your org (that contains the fork) to CodeCov.
3. Wait for the next run of CI in your fork (or push a dummy commit to it to trigger CI) to confirm CI is able to upload generated coverage data to CodeCov. If CodeCov is not set up correctly, the CI run will fail with an error message that mentions CodeCov.
4. Get the Markdown code for the Codecov badge provided in `Settings > Badges` and update the `docs/index.md` of your repo with it so that the badge [![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3) in that page reflects the coverage of your project.

### Repository-wide checks

Expand All @@ -59,22 +57,23 @@ Any warnings or errors will be printed out to the console.

**If adding new checks:**

* Checks are implemented as executable `check-*` scripts within the `.github` directory. The `run-checks.sh` script will automatically pick up and run files named as such. That is, you can add more such files if you need and the CI will do the rest.
- Checks are implemented as executable `check-*` scripts within the `.github` directory. The `run-checks.sh` script will automatically pick up and run files named as such. That is, you can add more such files if you need and the CI will do the rest.

- Check scripts should print out errors in the format `SEVERITY:FILENAME:LINE: MESSAGE`

* Check scripts should print out errors in the format `SEVERITY:FILENAME:LINE: MESSAGE`
* SEVERITY is either ERROR or WARN.
* FILENAME is the path to the file relative to the current directory.
* LINE is the line of the file where the error occurred and MESSAGE is the message explaining the error.
- SEVERITY is either ERROR or WARN.
- FILENAME is the path to the file relative to the current directory.
- LINE is the line of the file where the error occurred and MESSAGE is the message explaining the error.

* Check scripts must exit with a non-zero exit code if any errors occur.
- Check scripts must exit with a non-zero exit code if any errors occur.

--------------------------------------------------------------------------------------------------------------------
---

## Making a release

Here are the steps to create a new release.

1. Update the version number in [`MainApp.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java).
1. Generate a fat JAR file using Gradle (i.e., `gradlew shadowJar`).
1. Tag the repo with the version number. e.g. `v0.1`
1. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you created.
2. Generate a fat JAR file using Gradle (i.e., `gradlew shadowJar`).
3. Tag the repo with the version number. e.g. `v0.1`
4. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you created.
Loading

0 comments on commit 5348af6

Please sign in to comment.