Skip to content

Commit

Permalink
Update changelog and core readme docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
rkotze committed Dec 26, 2023
1 parent 01ad725 commit 2ef7487
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 13 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

Follows [Semantic Versioning](https://semver.org/).

## git-mob-core 0.9.0

### Added

- Specify authors to save when creating the coAuthor file.

## git-mob 3.1.1

### Added
Expand Down
41 changes: 28 additions & 13 deletions packages/git-mob-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,37 +18,52 @@ npm i git-mob-core
- `process.env.GITMOB_COAUTHORS_PATH` set the primary path to coauthors file

```TS
saveNewCoAuthors(authors): <Promise<Author[]>>
createCoAuthorsFile(): <Promise<boolean>>
// Write actions
saveNewCoAuthors(authors: Author[]): <Promise<Author[]>>
createCoAuthorsFile(authors: Author[]): <Promise<boolean>>
updateGitTemplate(selectedAuthors): void
solo(): <Promise<void>>
setCoAuthors(keys): <Promise<Author[]>>

// Read actions
getAllAuthors(): <Promise<Author[]>>
getPrimaryAuthor(): Author | undefined
getSelectedCoAuthors(allAuthors): Author[]
setCoAuthors(keys): <Promise<Author[]>>
setPrimaryAuthor(author): void
solo(): <Promise<void>>
updateGitTemplate(selectedAuthors): void
setPrimaryAuthor(author: Author): void
fetchGitHubAuthors(userNames: string[], userAgent: string): <Promise<Author[]>>
repoAuthorList(authorFilter?: string): Promise<Author[] | undefined>
pathToCoAuthors(): <Promise<string>>

gitRevParse = {
insideWorkTree(): <Promise<string>>,
topLevelDirectory(): <Promise<boolean>>,
};
```

### Config

```TS
// Config manager for library
// supported prop: "processCwd" = set the directory to exec commands
getConfig(prop: string): string | undefined
updateConfig(prop: string, value: string): void
repoAuthorList(authorFilter?: string): Promise<Author[] | undefined>

// Read GitMob properties from Git config file
gitMobConfig = {
localTemplate(): <Promise<boolean>>,
fetchFromGitHub(): <Promise<boolean>>,
};

// Read Git properties from Git config
gitConfig = {
getLocalCommitTemplate(): <Promise<string>>,
getGlobalCommitTemplate(): <Promise<string>>,
};

gitRevParse = {
insideWorkTree(): <Promise<string>>,
topLevelDirectory(): <Promise<boolean>>,
};
```

## Author class
### Author class

Main class for Author data exchange between function.

```TS
class Author;
Expand Down

0 comments on commit 2ef7487

Please sign in to comment.